├── .gitignore ├── .nvmrc ├── .prettierrc ├── .travis.yml ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── package-lock.json ├── package.json ├── src ├── img │ ├── eyes │ │ ├── eyes1.png │ │ ├── eyes10.png │ │ ├── eyes2.png │ │ ├── eyes3.png │ │ ├── eyes4.png │ │ ├── eyes5.png │ │ ├── eyes6.png │ │ ├── eyes7.png │ │ └── eyes9.png │ ├── mouth │ │ ├── mouth1.png │ │ ├── mouth10.png │ │ ├── mouth11.png │ │ ├── mouth3.png │ │ ├── mouth5.png │ │ ├── mouth6.png │ │ ├── mouth7.png │ │ └── mouth9.png │ └── nose │ │ ├── nose2.png │ │ ├── nose3.png │ │ ├── nose4.png │ │ ├── nose5.png │ │ ├── nose6.png │ │ ├── nose7.png │ │ ├── nose8.png │ │ └── nose9.png ├── index.ts ├── lib │ ├── FaceFactory.ts │ ├── imageFiles.ts │ └── imaging.ts └── router │ └── index.ts ├── test ├── favicon.ico ├── integration.test.ts ├── mocha.opts ├── server.ts └── tslint.json ├── tsconfig.json └── tslint.json /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | .env 3 | dist/ 4 | -------------------------------------------------------------------------------- /.nvmrc: -------------------------------------------------------------------------------- 1 | v10.24 2 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "printWidth": 80, 3 | "semi": true, 4 | "singleQuote": true, 5 | "tabWidth": 2, 6 | "trailingComma": "all" 7 | } 8 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | node_js: 3 | - "9" 4 | before_install: 5 | - sudo apt-get update 6 | - sudo apt-get install imagemagick graphicsmagick 7 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to contribute 2 | 3 | Want to contribute something to Adorable Avatars? Wonderful! __Here's how you can help.__ 4 | 5 | Please take a moment to review this document in order to make the contribution 6 | process easy and effective for everyone involved. 7 | 8 | ## Getting Started 9 | 10 | 1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, 11 | and configure the remotes: 12 | 13 | ```bash 14 | # Clone your fork of the repo into the current directory 15 | git clone https://github.com//avatars-api.git 16 | # Navigate to the newly cloned directory 17 | cd avatars-api 18 | # Assign the original repo to a remote called "upstream" 19 | git remote add upstream https://github.com/adorableio/avatars-api.git 20 | ``` 21 | 22 | 2. If you cloned a while ago, get the latest changes from upstream: 23 | 24 | ```bash 25 | git checkout master 26 | git pull upstream master 27 | ``` 28 | 29 | 3. Install the project dependencies: 30 | 31 | ```bash 32 | npm install 33 | brew install imagemagick 34 | ``` 35 | 36 | 4. Create a new topic branch (off the main project development branch) to 37 | contain your feature, change, or fix: 38 | 39 | ```bash 40 | git checkout -b 41 | ``` 42 | 43 | ## Making Changes 44 | 45 | 1. Commit your changes in logical chunks. Please adhere to these [git commit 46 | message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). 47 | Use Git's [interactive rebase](https://help.github.com/articles/interactive-rebase) 48 | feature to tidy up your commits before making them public. 49 | 50 | __NOTE__: Before you commit, ensure that the tests are still passing: 51 | ```bash 52 | npm test 53 | ``` 54 | 55 | If you're adding new functionality, please write specs around it. 56 | 57 | 2. Locally merge (or rebase) the upstream development branch into your topic branch: 58 | 59 | ```bash 60 | git pull [--rebase] upstream master 61 | ``` 62 | 63 | 3. Push your topic branch up to your fork: 64 | 65 | ```bash 66 | git push origin 67 | ``` 68 | 69 | 4. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) 70 | with a clear title and description against the `master` branch. 71 | 72 | ## License 73 | 74 | By contributing your code, you agree to license your contribution under the [MIT license](LICENSE). 75 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (c) 2019 Kevin Altman 2 | 3 | The art components that are used to build the adorableavatars.com site are the original, copyrighted work created by Kevin Altman, and are similarly licensed under GPLv3. 4 | 5 | Additionally, the art generated from the adorableavatars.com site and service are the original, copyrighted work created by Kevin Altman, and are similarly licensed under GPLv3. 6 | 7 | Any artifactes generated, or created using the art components of adorableavatars.com my not be sold, or distributed without written consent by Kevin Altman. 8 | 9 | GNU GENERAL PUBLIC LICENSE 10 | Version 3, 29 June 2007 11 | 12 | Copyright (C) 2007 Free Software Foundation, Inc. 13 | Everyone is permitted to copy and distribute verbatim copies 14 | of this license document, but changing it is not allowed. 15 | 16 | Preamble 17 | 18 | The GNU General Public License is a free, copyleft license for 19 | software and other kinds of works. 20 | 21 | The licenses for most software and other practical works are designed 22 | to take away your freedom to share and change the works. By contrast, 23 | the GNU General Public License is intended to guarantee your freedom to 24 | share and change all versions of a program--to make sure it remains free 25 | software for all its users. We, the Free Software Foundation, use the 26 | GNU General Public License for most of our software; it applies also to 27 | any other work released this way by its authors. You can apply it to 28 | your programs, too. 29 | 30 | When we speak of free software, we are referring to freedom, not 31 | price. Our General Public Licenses are designed to make sure that you 32 | have the freedom to distribute copies of free software (and charge for 33 | them if you wish), that you receive source code or can get it if you 34 | want it, that you can change the software or use pieces of it in new 35 | free programs, and that you know you can do these things. 36 | 37 | To protect your rights, we need to prevent others from denying you 38 | these rights or asking you to surrender the rights. Therefore, you have 39 | certain responsibilities if you distribute copies of the software, or if 40 | you modify it: responsibilities to respect the freedom of others. 41 | 42 | For example, if you distribute copies of such a program, whether 43 | gratis or for a fee, you must pass on to the recipients the same 44 | freedoms that you received. You must make sure that they, too, receive 45 | or can get the source code. And you must show them these terms so they 46 | know their rights. 47 | 48 | Developers that use the GNU GPL protect your rights with two steps: 49 | (1) assert copyright on the software, and (2) offer you this License 50 | giving you legal permission to copy, distribute and/or modify it. 51 | 52 | For the developers' and authors' protection, the GPL clearly explains 53 | that there is no warranty for this free software. For both users' and 54 | authors' sake, the GPL requires that modified versions be marked as 55 | changed, so that their problems will not be attributed erroneously to 56 | authors of previous versions. 57 | 58 | Some devices are designed to deny users access to install or run 59 | modified versions of the software inside them, although the manufacturer 60 | can do so. This is fundamentally incompatible with the aim of 61 | protecting users' freedom to change the software. The systematic 62 | pattern of such abuse occurs in the area of products for individuals to 63 | use, which is precisely where it is most unacceptable. Therefore, we 64 | have designed this version of the GPL to prohibit the practice for those 65 | products. If such problems arise substantially in other domains, we 66 | stand ready to extend this provision to those domains in future versions 67 | of the GPL, as needed to protect the freedom of users. 68 | 69 | Finally, every program is threatened constantly by software patents. 70 | States should not allow patents to restrict development and use of 71 | software on general-purpose computers, but in those that do, we wish to 72 | avoid the special danger that patents applied to a free program could 73 | make it effectively proprietary. To prevent this, the GPL assures that 74 | patents cannot be used to render the program non-free. 75 | 76 | The precise terms and conditions for copying, distribution and 77 | modification follow. 78 | 79 | TERMS AND CONDITIONS 80 | 81 | 0. Definitions. 82 | 83 | "This License" refers to version 3 of the GNU General Public License. 84 | 85 | "Copyright" also means copyright-like laws that apply to other kinds of 86 | works, such as semiconductor masks. 87 | 88 | "The Program" refers to any copyrightable work licensed under this 89 | License. Each licensee is addressed as "you". "Licensees" and 90 | "recipients" may be individuals or organizations. 91 | 92 | To "modify" a work means to copy from or adapt all or part of the work 93 | in a fashion requiring copyright permission, other than the making of an 94 | exact copy. The resulting work is called a "modified version" of the 95 | earlier work or a work "based on" the earlier work. 96 | 97 | A "covered work" means either the unmodified Program or a work based 98 | on the Program. 99 | 100 | To "propagate" a work means to do anything with it that, without 101 | permission, would make you directly or secondarily liable for 102 | infringement under applicable copyright law, except executing it on a 103 | computer or modifying a private copy. Propagation includes copying, 104 | distribution (with or without modification), making available to the 105 | public, and in some countries other activities as well. 106 | 107 | To "convey" a work means any kind of propagation that enables other 108 | parties to make or receive copies. Mere interaction with a user through 109 | a computer network, with no transfer of a copy, is not conveying. 110 | 111 | An interactive user interface displays "Appropriate Legal Notices" 112 | to the extent that it includes a convenient and prominently visible 113 | feature that (1) displays an appropriate copyright notice, and (2) 114 | tells the user that there is no warranty for the work (except to the 115 | extent that warranties are provided), that licensees may convey the 116 | work under this License, and how to view a copy of this License. If 117 | the interface presents a list of user commands or options, such as a 118 | menu, a prominent item in the list meets this criterion. 119 | 120 | 1. Source Code. 121 | 122 | The "source code" for a work means the preferred form of the work 123 | for making modifications to it. "Object code" means any non-source 124 | form of a work. 125 | 126 | A "Standard Interface" means an interface that either is an official 127 | standard defined by a recognized standards body, or, in the case of 128 | interfaces specified for a particular programming language, one that 129 | is widely used among developers working in that language. 130 | 131 | The "System Libraries" of an executable work include anything, other 132 | than the work as a whole, that (a) is included in the normal form of 133 | packaging a Major Component, but which is not part of that Major 134 | Component, and (b) serves only to enable use of the work with that 135 | Major Component, or to implement a Standard Interface for which an 136 | implementation is available to the public in source code form. A 137 | "Major Component", in this context, means a major essential component 138 | (kernel, window system, and so on) of the specific operating system 139 | (if any) on which the executable work runs, or a compiler used to 140 | produce the work, or an object code interpreter used to run it. 141 | 142 | The "Corresponding Source" for a work in object code form means all 143 | the source code needed to generate, install, and (for an executable 144 | work) run the object code and to modify the work, including scripts to 145 | control those activities. However, it does not include the work's 146 | System Libraries, or general-purpose tools or generally available free 147 | programs which are used unmodified in performing those activities but 148 | which are not part of the work. For example, Corresponding Source 149 | includes interface definition files associated with source files for 150 | the work, and the source code for shared libraries and dynamically 151 | linked subprograms that the work is specifically designed to require, 152 | such as by intimate data communication or control flow between those 153 | subprograms and other parts of the work. 154 | 155 | The Corresponding Source need not include anything that users 156 | can regenerate automatically from other parts of the Corresponding 157 | Source. 158 | 159 | The Corresponding Source for a work in source code form is that 160 | same work. 161 | 162 | 2. Basic Permissions. 163 | 164 | All rights granted under this License are granted for the term of 165 | copyright on the Program, and are irrevocable provided the stated 166 | conditions are met. This License explicitly affirms your unlimited 167 | permission to run the unmodified Program. The output from running a 168 | covered work is covered by this License only if the output, given its 169 | content, constitutes a covered work. This License acknowledges your 170 | rights of fair use or other equivalent, as provided by copyright law. 171 | 172 | You may make, run and propagate covered works that you do not 173 | convey, without conditions so long as your license otherwise remains 174 | in force. You may convey covered works to others for the sole purpose 175 | of having them make modifications exclusively for you, or provide you 176 | with facilities for running those works, provided that you comply with 177 | the terms of this License in conveying all material for which you do 178 | not control copyright. Those thus making or running the covered works 179 | for you must do so exclusively on your behalf, under your direction 180 | and control, on terms that prohibit them from making any copies of 181 | your copyrighted material outside their relationship with you. 182 | 183 | Conveying under any other circumstances is permitted solely under 184 | the conditions stated below. Sublicensing is not allowed; section 10 185 | makes it unnecessary. 186 | 187 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 188 | 189 | No covered work shall be deemed part of an effective technological 190 | measure under any applicable law fulfilling obligations under article 191 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 192 | similar laws prohibiting or restricting circumvention of such 193 | measures. 194 | 195 | When you convey a covered work, you waive any legal power to forbid 196 | circumvention of technological measures to the extent such circumvention 197 | is effected by exercising rights under this License with respect to 198 | the covered work, and you disclaim any intention to limit operation or 199 | modification of the work as a means of enforcing, against the work's 200 | users, your or third parties' legal rights to forbid circumvention of 201 | technological measures. 202 | 203 | 4. Conveying Verbatim Copies. 204 | 205 | You may convey verbatim copies of the Program's source code as you 206 | receive it, in any medium, provided that you conspicuously and 207 | appropriately publish on each copy an appropriate copyright notice; 208 | keep intact all notices stating that this License and any 209 | non-permissive terms added in accord with section 7 apply to the code; 210 | keep intact all notices of the absence of any warranty; and give all 211 | recipients a copy of this License along with the Program. 212 | 213 | You may charge any price or no price for each copy that you convey, 214 | and you may offer support or warranty protection for a fee. 215 | 216 | 5. Conveying Modified Source Versions. 217 | 218 | You may convey a work based on the Program, or the modifications to 219 | produce it from the Program, in the form of source code under the 220 | terms of section 4, provided that you also meet all of these conditions: 221 | 222 | a) The work must carry prominent notices stating that you modified 223 | it, and giving a relevant date. 224 | 225 | b) The work must carry prominent notices stating that it is 226 | released under this License and any conditions added under section 227 | 7. This requirement modifies the requirement in section 4 to 228 | "keep intact all notices". 229 | 230 | c) You must license the entire work, as a whole, under this 231 | License to anyone who comes into possession of a copy. This 232 | License will therefore apply, along with any applicable section 7 233 | additional terms, to the whole of the work, and all its parts, 234 | regardless of how they are packaged. This License gives no 235 | permission to license the work in any other way, but it does not 236 | invalidate such permission if you have separately received it. 237 | 238 | d) If the work has interactive user interfaces, each must display 239 | Appropriate Legal Notices; however, if the Program has interactive 240 | interfaces that do not display Appropriate Legal Notices, your 241 | work need not make them do so. 242 | 243 | A compilation of a covered work with other separate and independent 244 | works, which are not by their nature extensions of the covered work, 245 | and which are not combined with it such as to form a larger program, 246 | in or on a volume of a storage or distribution medium, is called an 247 | "aggregate" if the compilation and its resulting copyright are not 248 | used to limit the access or legal rights of the compilation's users 249 | beyond what the individual works permit. Inclusion of a covered work 250 | in an aggregate does not cause this License to apply to the other 251 | parts of the aggregate. 252 | 253 | 6. Conveying Non-Source Forms. 254 | 255 | You may convey a covered work in object code form under the terms 256 | of sections 4 and 5, provided that you also convey the 257 | machine-readable Corresponding Source under the terms of this License, 258 | in one of these ways: 259 | 260 | a) Convey the object code in, or embodied in, a physical product 261 | (including a physical distribution medium), accompanied by the 262 | Corresponding Source fixed on a durable physical medium 263 | customarily used for software interchange. 264 | 265 | b) Convey the object code in, or embodied in, a physical product 266 | (including a physical distribution medium), accompanied by a 267 | written offer, valid for at least three years and valid for as 268 | long as you offer spare parts or customer support for that product 269 | model, to give anyone who possesses the object code either (1) a 270 | copy of the Corresponding Source for all the software in the 271 | product that is covered by this License, on a durable physical 272 | medium customarily used for software interchange, for a price no 273 | more than your reasonable cost of physically performing this 274 | conveying of source, or (2) access to copy the 275 | Corresponding Source from a network server at no charge. 276 | 277 | c) Convey individual copies of the object code with a copy of the 278 | written offer to provide the Corresponding Source. This 279 | alternative is allowed only occasionally and noncommercially, and 280 | only if you received the object code with such an offer, in accord 281 | with subsection 6b. 282 | 283 | d) Convey the object code by offering access from a designated 284 | place (gratis or for a charge), and offer equivalent access to the 285 | Corresponding Source in the same way through the same place at no 286 | further charge. You need not require recipients to copy the 287 | Corresponding Source along with the object code. If the place to 288 | copy the object code is a network server, the Corresponding Source 289 | may be on a different server (operated by you or a third party) 290 | that supports equivalent copying facilities, provided you maintain 291 | clear directions next to the object code saying where to find the 292 | Corresponding Source. Regardless of what server hosts the 293 | Corresponding Source, you remain obligated to ensure that it is 294 | available for as long as needed to satisfy these requirements. 295 | 296 | e) Convey the object code using peer-to-peer transmission, provided 297 | you inform other peers where the object code and Corresponding 298 | Source of the work are being offered to the general public at no 299 | charge under subsection 6d. 300 | 301 | A separable portion of the object code, whose source code is excluded 302 | from the Corresponding Source as a System Library, need not be 303 | included in conveying the object code work. 304 | 305 | A "User Product" is either (1) a "consumer product", which means any 306 | tangible personal property which is normally used for personal, family, 307 | or household purposes, or (2) anything designed or sold for incorporation 308 | into a dwelling. In determining whether a product is a consumer product, 309 | doubtful cases shall be resolved in favor of coverage. For a particular 310 | product received by a particular user, "normally used" refers to a 311 | typical or common use of that class of product, regardless of the status 312 | of the particular user or of the way in which the particular user 313 | actually uses, or expects or is expected to use, the product. A product 314 | is a consumer product regardless of whether the product has substantial 315 | commercial, industrial or non-consumer uses, unless such uses represent 316 | the only significant mode of use of the product. 317 | 318 | "Installation Information" for a User Product means any methods, 319 | procedures, authorization keys, or other information required to install 320 | and execute modified versions of a covered work in that User Product from 321 | a modified version of its Corresponding Source. The information must 322 | suffice to ensure that the continued functioning of the modified object 323 | code is in no case prevented or interfered with solely because 324 | modification has been made. 325 | 326 | If you convey an object code work under this section in, or with, or 327 | specifically for use in, a User Product, and the conveying occurs as 328 | part of a transaction in which the right of possession and use of the 329 | User Product is transferred to the recipient in perpetuity or for a 330 | fixed term (regardless of how the transaction is characterized), the 331 | Corresponding Source conveyed under this section must be accompanied 332 | by the Installation Information. But this requirement does not apply 333 | if neither you nor any third party retains the ability to install 334 | modified object code on the User Product (for example, the work has 335 | been installed in ROM). 336 | 337 | The requirement to provide Installation Information does not include a 338 | requirement to continue to provide support service, warranty, or updates 339 | for a work that has been modified or installed by the recipient, or for 340 | the User Product in which it has been modified or installed. Access to a 341 | network may be denied when the modification itself materially and 342 | adversely affects the operation of the network or violates the rules and 343 | protocols for communication across the network. 344 | 345 | Corresponding Source conveyed, and Installation Information provided, 346 | in accord with this section must be in a format that is publicly 347 | documented (and with an implementation available to the public in 348 | source code form), and must require no special password or key for 349 | unpacking, reading or copying. 350 | 351 | 7. Additional Terms. 352 | 353 | "Additional permissions" are terms that supplement the terms of this 354 | License by making exceptions from one or more of its conditions. 355 | Additional permissions that are applicable to the entire Program shall 356 | be treated as though they were included in this License, to the extent 357 | that they are valid under applicable law. If additional permissions 358 | apply only to part of the Program, that part may be used separately 359 | under those permissions, but the entire Program remains governed by 360 | this License without regard to the additional permissions. 361 | 362 | When you convey a copy of a covered work, you may at your option 363 | remove any additional permissions from that copy, or from any part of 364 | it. (Additional permissions may be written to require their own 365 | removal in certain cases when you modify the work.) You may place 366 | additional permissions on material, added by you to a covered work, 367 | for which you have or can give appropriate copyright permission. 368 | 369 | Notwithstanding any other provision of this License, for material you 370 | add to a covered work, you may (if authorized by the copyright holders of 371 | that material) supplement the terms of this License with terms: 372 | 373 | a) Disclaiming warranty or limiting liability differently from the 374 | terms of sections 15 and 16 of this License; or 375 | 376 | b) Requiring preservation of specified reasonable legal notices or 377 | author attributions in that material or in the Appropriate Legal 378 | Notices displayed by works containing it; or 379 | 380 | c) Prohibiting misrepresentation of the origin of that material, or 381 | requiring that modified versions of such material be marked in 382 | reasonable ways as different from the original version; or 383 | 384 | d) Limiting the use for publicity purposes of names of licensors or 385 | authors of the material; or 386 | 387 | e) Declining to grant rights under trademark law for use of some 388 | trade names, trademarks, or service marks; or 389 | 390 | f) Requiring indemnification of licensors and authors of that 391 | material by anyone who conveys the material (or modified versions of 392 | it) with contractual assumptions of liability to the recipient, for 393 | any liability that these contractual assumptions directly impose on 394 | those licensors and authors. 395 | 396 | All other non-permissive additional terms are considered "further 397 | restrictions" within the meaning of section 10. If the Program as you 398 | received it, or any part of it, contains a notice stating that it is 399 | governed by this License along with a term that is a further 400 | restriction, you may remove that term. If a license document contains 401 | a further restriction but permits relicensing or conveying under this 402 | License, you may add to a covered work material governed by the terms 403 | of that license document, provided that the further restriction does 404 | not survive such relicensing or conveying. 405 | 406 | If you add terms to a covered work in accord with this section, you 407 | must place, in the relevant source files, a statement of the 408 | additional terms that apply to those files, or a notice indicating 409 | where to find the applicable terms. 410 | 411 | Additional terms, permissive or non-permissive, may be stated in the 412 | form of a separately written license, or stated as exceptions; 413 | the above requirements apply either way. 414 | 415 | 8. Termination. 416 | 417 | You may not propagate or modify a covered work except as expressly 418 | provided under this License. Any attempt otherwise to propagate or 419 | modify it is void, and will automatically terminate your rights under 420 | this License (including any patent licenses granted under the third 421 | paragraph of section 11). 422 | 423 | However, if you cease all violation of this License, then your 424 | license from a particular copyright holder is reinstated (a) 425 | provisionally, unless and until the copyright holder explicitly and 426 | finally terminates your license, and (b) permanently, if the copyright 427 | holder fails to notify you of the violation by some reasonable means 428 | prior to 60 days after the cessation. 429 | 430 | Moreover, your license from a particular copyright holder is 431 | reinstated permanently if the copyright holder notifies you of the 432 | violation by some reasonable means, this is the first time you have 433 | received notice of violation of this License (for any work) from that 434 | copyright holder, and you cure the violation prior to 30 days after 435 | your receipt of the notice. 436 | 437 | Termination of your rights under this section does not terminate the 438 | licenses of parties who have received copies or rights from you under 439 | this License. If your rights have been terminated and not permanently 440 | reinstated, you do not qualify to receive new licenses for the same 441 | material under section 10. 442 | 443 | 9. Acceptance Not Required for Having Copies. 444 | 445 | You are not required to accept this License in order to receive or 446 | run a copy of the Program. Ancillary propagation of a covered work 447 | occurring solely as a consequence of using peer-to-peer transmission 448 | to receive a copy likewise does not require acceptance. However, 449 | nothing other than this License grants you permission to propagate or 450 | modify any covered work. These actions infringe copyright if you do 451 | not accept this License. Therefore, by modifying or propagating a 452 | covered work, you indicate your acceptance of this License to do so. 453 | 454 | 10. Automatic Licensing of Downstream Recipients. 455 | 456 | Each time you convey a covered work, the recipient automatically 457 | receives a license from the original licensors, to run, modify and 458 | propagate that work, subject to this License. You are not responsible 459 | for enforcing compliance by third parties with this License. 460 | 461 | An "entity transaction" is a transaction transferring control of an 462 | organization, or substantially all assets of one, or subdividing an 463 | organization, or merging organizations. If propagation of a covered 464 | work results from an entity transaction, each party to that 465 | transaction who receives a copy of the work also receives whatever 466 | licenses to the work the party's predecessor in interest had or could 467 | give under the previous paragraph, plus a right to possession of the 468 | Corresponding Source of the work from the predecessor in interest, if 469 | the predecessor has it or can get it with reasonable efforts. 470 | 471 | You may not impose any further restrictions on the exercise of the 472 | rights granted or affirmed under this License. For example, you may 473 | not impose a license fee, royalty, or other charge for exercise of 474 | rights granted under this License, and you may not initiate litigation 475 | (including a cross-claim or counterclaim in a lawsuit) alleging that 476 | any patent claim is infringed by making, using, selling, offering for 477 | sale, or importing the Program or any portion of it. 478 | 479 | 11. Patents. 480 | 481 | A "contributor" is a copyright holder who authorizes use under this 482 | License of the Program or a work on which the Program is based. The 483 | work thus licensed is called the contributor's "contributor version". 484 | 485 | A contributor's "essential patent claims" are all patent claims 486 | owned or controlled by the contributor, whether already acquired or 487 | hereafter acquired, that would be infringed by some manner, permitted 488 | by this License, of making, using, or selling its contributor version, 489 | but do not include claims that would be infringed only as a 490 | consequence of further modification of the contributor version. For 491 | purposes of this definition, "control" includes the right to grant 492 | patent sublicenses in a manner consistent with the requirements of 493 | this License. 494 | 495 | Each contributor grants you a non-exclusive, worldwide, royalty-free 496 | patent license under the contributor's essential patent claims, to 497 | make, use, sell, offer for sale, import and otherwise run, modify and 498 | propagate the contents of its contributor version. 499 | 500 | In the following three paragraphs, a "patent license" is any express 501 | agreement or commitment, however denominated, not to enforce a patent 502 | (such as an express permission to practice a patent or covenant not to 503 | sue for patent infringement). To "grant" such a patent license to a 504 | party means to make such an agreement or commitment not to enforce a 505 | patent against the party. 506 | 507 | If you convey a covered work, knowingly relying on a patent license, 508 | and the Corresponding Source of the work is not available for anyone 509 | to copy, free of charge and under the terms of this License, through a 510 | publicly available network server or other readily accessible means, 511 | then you must either (1) cause the Corresponding Source to be so 512 | available, or (2) arrange to deprive yourself of the benefit of the 513 | patent license for this particular work, or (3) arrange, in a manner 514 | consistent with the requirements of this License, to extend the patent 515 | license to downstream recipients. "Knowingly relying" means you have 516 | actual knowledge that, but for the patent license, your conveying the 517 | covered work in a country, or your recipient's use of the covered work 518 | in a country, would infringe one or more identifiable patents in that 519 | country that you have reason to believe are valid. 520 | 521 | If, pursuant to or in connection with a single transaction or 522 | arrangement, you convey, or propagate by procuring conveyance of, a 523 | covered work, and grant a patent license to some of the parties 524 | receiving the covered work authorizing them to use, propagate, modify 525 | or convey a specific copy of the covered work, then the patent license 526 | you grant is automatically extended to all recipients of the covered 527 | work and works based on it. 528 | 529 | A patent license is "discriminatory" if it does not include within 530 | the scope of its coverage, prohibits the exercise of, or is 531 | conditioned on the non-exercise of one or more of the rights that are 532 | specifically granted under this License. You may not convey a covered 533 | work if you are a party to an arrangement with a third party that is 534 | in the business of distributing software, under which you make payment 535 | to the third party based on the extent of your activity of conveying 536 | the work, and under which the third party grants, to any of the 537 | parties who would receive the covered work from you, a discriminatory 538 | patent license (a) in connection with copies of the covered work 539 | conveyed by you (or copies made from those copies), or (b) primarily 540 | for and in connection with specific products or compilations that 541 | contain the covered work, unless you entered into that arrangement, 542 | or that patent license was granted, prior to 28 March 2007. 543 | 544 | Nothing in this License shall be construed as excluding or limiting 545 | any implied license or other defenses to infringement that may 546 | otherwise be available to you under applicable patent law. 547 | 548 | 12. No Surrender of Others' Freedom. 549 | 550 | If conditions are imposed on you (whether by court order, agreement or 551 | otherwise) that contradict the conditions of this License, they do not 552 | excuse you from the conditions of this License. If you cannot convey a 553 | covered work so as to satisfy simultaneously your obligations under this 554 | License and any other pertinent obligations, then as a consequence you may 555 | not convey it at all. For example, if you agree to terms that obligate you 556 | to collect a royalty for further conveying from those to whom you convey 557 | the Program, the only way you could satisfy both those terms and this 558 | License would be to refrain entirely from conveying the Program. 559 | 560 | 13. Use with the GNU Affero General Public License. 561 | 562 | Notwithstanding any other provision of this License, you have 563 | permission to link or combine any covered work with a work licensed 564 | under version 3 of the GNU Affero General Public License into a single 565 | combined work, and to convey the resulting work. The terms of this 566 | License will continue to apply to the part which is the covered work, 567 | but the special requirements of the GNU Affero General Public License, 568 | section 13, concerning interaction through a network will apply to the 569 | combination as such. 570 | 571 | 14. Revised Versions of this License. 572 | 573 | The Free Software Foundation may publish revised and/or new versions of 574 | the GNU General Public License from time to time. Such new versions will 575 | be similar in spirit to the present version, but may differ in detail to 576 | address new problems or concerns. 577 | 578 | Each version is given a distinguishing version number. If the 579 | Program specifies that a certain numbered version of the GNU General 580 | Public License "or any later version" applies to it, you have the 581 | option of following the terms and conditions either of that numbered 582 | version or of any later version published by the Free Software 583 | Foundation. If the Program does not specify a version number of the 584 | GNU General Public License, you may choose any version ever published 585 | by the Free Software Foundation. 586 | 587 | If the Program specifies that a proxy can decide which future 588 | versions of the GNU General Public License can be used, that proxy's 589 | public statement of acceptance of a version permanently authorizes you 590 | to choose that version for the Program. 591 | 592 | Later license versions may give you additional or different 593 | permissions. However, no additional obligations are imposed on any 594 | author or copyright holder as a result of your choosing to follow a 595 | later version. 596 | 597 | 15. Disclaimer of Warranty. 598 | 599 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 600 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 601 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 602 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 603 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 604 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 605 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 606 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 607 | 608 | 16. Limitation of Liability. 609 | 610 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 611 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 612 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 613 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 614 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 615 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 616 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 617 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 618 | SUCH DAMAGES. 619 | 620 | 17. Interpretation of Sections 15 and 16. 621 | 622 | If the disclaimer of warranty and limitation of liability provided 623 | above cannot be given local legal effect according to their terms, 624 | reviewing courts shall apply local law that most closely approximates 625 | an absolute waiver of all civil liability in connection with the 626 | Program, unless a warranty or assumption of liability accompanies a 627 | copy of the Program in return for a fee. 628 | 629 | END OF TERMS AND CONDITIONS 630 | 631 | How to Apply These Terms to Your New Programs 632 | 633 | If you develop a new program, and you want it to be of the greatest 634 | possible use to the public, the best way to achieve this is to make it 635 | free software which everyone can redistribute and change under these terms. 636 | 637 | To do so, attach the following notices to the program. It is safest 638 | to attach them to the start of each source file to most effectively 639 | state the exclusion of warranty; and each file should have at least 640 | the "copyright" line and a pointer to where the full notice is found. 641 | 642 | 643 | Copyright (C) 644 | 645 | This program is free software: you can redistribute it and/or modify 646 | it under the terms of the GNU General Public License as published by 647 | the Free Software Foundation, either version 3 of the License, or 648 | (at your option) any later version. 649 | 650 | This program is distributed in the hope that it will be useful, 651 | but WITHOUT ANY WARRANTY; without even the implied warranty of 652 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 653 | GNU General Public License for more details. 654 | 655 | You should have received a copy of the GNU General Public License 656 | along with this program. If not, see . 657 | 658 | Also add information on how to contact you by electronic and paper mail. 659 | 660 | If the program does terminal interaction, make it output a short 661 | notice like this when it starts in an interactive mode: 662 | 663 | Copyright (C) 664 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 665 | This is free software, and you are welcome to redistribute it 666 | under certain conditions; type `show c' for details. 667 | 668 | The hypothetical commands `show w' and `show c' should show the appropriate 669 | parts of the General Public License. Of course, your program's commands 670 | might be different; for a GUI interface, you would use an "about box". 671 | 672 | You should also get your employer (if you work as a programmer) or school, 673 | if any, to sign a "copyright disclaimer" for the program, if necessary. 674 | For more information on this, and how to apply and follow the GNU GPL, see 675 | . 676 | 677 | The GNU General Public License does not permit incorporating your program 678 | into proprietary programs. If your program is a subroutine library, you 679 | may consider it more useful to permit linking proprietary applications with 680 | the library. If this is what you want to do, use the GNU Lesser General 681 | Public License instead of this License. But first, please read 682 | . 683 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # adorable-avatars 2 | [![Build Status](https://travis-ci.org/adorableio/avatars-api-middleware.svg)](https://travis-ci.org/adorableio/avatars-api-middleware) 3 | 4 | ## What is it? 5 | This repository contains the [express middleware](https://expressjs.com/en/guide/using-middleware.html#middleware.router) that can be used to host your own avatars service! 6 | 7 | Check out [our website](http://avatars.adorable.io/) for more info on (and an interactive demo of) what this service does. 8 | 9 | ## How do I use it? 10 | First, you'll need the `adorable-avatars` package: 11 | 12 | ```bash 13 | npm install adorable-avatars --save 14 | ``` 15 | 16 | Then, use the router middleware within your application: 17 | 18 | ```js 19 | // your_server.js 20 | import express from 'express'; 21 | import avatarsMiddleware from 'adorable-avatars'; 22 | 23 | const myApp = express(); 24 | myApp.use('/myAvatars', avatarsMiddleware); 25 | ``` 26 | 27 | That's it! Your server now includes the avatars endpoints! 28 | 29 | ### Endpoints 30 | Assuming your server lives at `myserver.com`, and you've configured the middleware as above, you now have the following endpoints: 31 | 32 | * `myserver.com/myAvatars/:id` 33 | * returns an avatar for the provided `id`. 34 | * `id` can be anything (email, username, md5 hash, as long as it's a valid URI) 35 | * defaults to 400px 36 | * `myserver.com/myAvatars/:size/:id` 37 | * returns an avatar for the provided `id` at the specified `size` 38 | * size cannot exceed 400px 39 | * `myserver.com/myAvatars/face/:eyes/:nose/:mouth/:color/:size?` 40 | * Allows you to generate a custom avatar from the specified parts and color, and size 41 | * e.g. `myserver.com/myAvatars/face/eyes1/nose2/mouth4/DEADBF/300` 42 | * `myserver.com/myAvatars/list` 43 | * returns JSON of all valid parts for the custom endpoint above 44 | * `myserver.com/myAvatars/:size?/random` 45 | * returns a random avatar, different each time 46 | * e.g. `myserver.com/myAvatars/300/random` 47 | 48 | 49 | ## Development 50 | If you're developing locally, you'll first need to bootstrap (assumes [nvm](https://github.com/creationix/nvm)): 51 | 52 | ```bash 53 | # use correct node version 54 | nvm use 55 | 56 | # install dependencies 57 | npm install 58 | ``` 59 | 60 | Then, there are several npm scripts that will be useful: 61 | 62 | ```bash 63 | # run the unit tests 64 | npm test 65 | 66 | # run both a dev server and eslint 67 | npm run dev 68 | 69 | # run a dev server 70 | npm run dev:server 71 | 72 | # run eslint 73 | npm run dev:lint 74 | 75 | # compile the application 76 | npm run build 77 | ``` 78 | 79 | ## Contributing 80 | 81 | Please read the [contributors' guide](CONTRIBUTING.md) 82 | 83 | ## Open-source Contributors 84 | 85 | * Kevin Altman [twitter @itg](https://twitter.com/itg) [github @itsthaguy](https://github.com/itsthatguy): Creator of Adorable Avatars, service, site, and artwork. 86 | * Ryland Herrick [github @rylnd](https://github.com/rylnd): Programmer extraordinaire! 87 | * [twitter @missingdink](https://twitter.com/missingdink): Illustrated the very first avatars! [Check them out!](http://api.adorable.io/avatar/hi_mom) 88 | 89 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "adorable-avatars", 3 | "version": "0.2.2-alpha.0", 4 | "description": "", 5 | "engines": { 6 | "node": ">= 10.24.x" 7 | }, 8 | "scripts": { 9 | "test": "mocha --exit", 10 | "build": "tsc && npm run build:assets", 11 | "build:assets": "cp -r {src,dist}/img", 12 | "dev": "concurrently --kill-others --prefix=name --names=server,tslint --prefix-colors=green,magenta \"npm run dev:server\" \"npm run dev:lint\"", 13 | "dev:server": "onchange -i -k 'src/**/*.ts' -- ts-node test/server.ts", 14 | "dev:lint": "onchange -i -k 'src/**/*.ts' -- tslint -t stylish 'src/**/*.ts'", 15 | "prepublishOnly": "npm run build" 16 | }, 17 | "author": "", 18 | "license": "MIT", 19 | "main": "dist/index.js", 20 | "types": "dist/index.d.ts", 21 | "files": [ 22 | "dist" 23 | ], 24 | "dependencies": { 25 | "avatars-utils": "0.0.4", 26 | "express": "^4.16.4", 27 | "sharp": "^0.25.3", 28 | "uuid": "^3.3.2" 29 | }, 30 | "repository": { 31 | "type": "git", 32 | "url": "https://github.com/adorableio/adorable-avatars.git" 33 | }, 34 | "devDependencies": { 35 | "@types/express": "^4.16.1", 36 | "@types/mocha": "^5.2.6", 37 | "@types/node": "^11.13.4", 38 | "@types/serve-favicon": "^2.2.30", 39 | "@types/sharp": "^0.22.1", 40 | "@types/supertest": "^2.0.7", 41 | "chai": "^4.2.0", 42 | "concurrently": "^4.1.0", 43 | "mocha": "^6.1.4", 44 | "onchange": "^5.2.0", 45 | "prettier": "^1.17.0", 46 | "serve-favicon": "^2.5.0", 47 | "supertest": "^4.0.2", 48 | "ts-node": "^8.1.0", 49 | "tslint": "^5.15.0", 50 | "tslint-config-prettier": "^1.18.0", 51 | "tslint-plugin-prettier": "^2.0.1", 52 | "typescript": "^3.4.3" 53 | } 54 | } 55 | -------------------------------------------------------------------------------- /src/img/eyes/eyes1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/eyes/eyes1.png -------------------------------------------------------------------------------- /src/img/eyes/eyes10.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/eyes/eyes10.png -------------------------------------------------------------------------------- /src/img/eyes/eyes2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/eyes/eyes2.png -------------------------------------------------------------------------------- /src/img/eyes/eyes3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/eyes/eyes3.png -------------------------------------------------------------------------------- /src/img/eyes/eyes4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/eyes/eyes4.png -------------------------------------------------------------------------------- /src/img/eyes/eyes5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/eyes/eyes5.png -------------------------------------------------------------------------------- /src/img/eyes/eyes6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/eyes/eyes6.png -------------------------------------------------------------------------------- /src/img/eyes/eyes7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/eyes/eyes7.png -------------------------------------------------------------------------------- /src/img/eyes/eyes9.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/eyes/eyes9.png -------------------------------------------------------------------------------- /src/img/mouth/mouth1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/mouth/mouth1.png -------------------------------------------------------------------------------- /src/img/mouth/mouth10.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/mouth/mouth10.png -------------------------------------------------------------------------------- /src/img/mouth/mouth11.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/mouth/mouth11.png -------------------------------------------------------------------------------- /src/img/mouth/mouth3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/mouth/mouth3.png -------------------------------------------------------------------------------- /src/img/mouth/mouth5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/mouth/mouth5.png -------------------------------------------------------------------------------- /src/img/mouth/mouth6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/mouth/mouth6.png -------------------------------------------------------------------------------- /src/img/mouth/mouth7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/mouth/mouth7.png -------------------------------------------------------------------------------- /src/img/mouth/mouth9.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/mouth/mouth9.png -------------------------------------------------------------------------------- /src/img/nose/nose2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/nose/nose2.png -------------------------------------------------------------------------------- /src/img/nose/nose3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/nose/nose3.png -------------------------------------------------------------------------------- /src/img/nose/nose4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/nose/nose4.png -------------------------------------------------------------------------------- /src/img/nose/nose5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/nose/nose5.png -------------------------------------------------------------------------------- /src/img/nose/nose6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/nose/nose6.png -------------------------------------------------------------------------------- /src/img/nose/nose7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/nose/nose7.png -------------------------------------------------------------------------------- /src/img/nose/nose8.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/nose/nose8.png -------------------------------------------------------------------------------- /src/img/nose/nose9.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/src/img/nose/nose9.png -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | import router from './router'; 2 | 3 | export default router; 4 | (module as any).exports = router; 5 | -------------------------------------------------------------------------------- /src/lib/FaceFactory.ts: -------------------------------------------------------------------------------- 1 | import { Hash, hashFactory, sumAndDiff } from 'avatars-utils'; 2 | import { eyeImages, noseImages, mouthImages } from './imageFiles'; 3 | 4 | export interface Face { 5 | color: string; 6 | eyes: string; 7 | nose: string; 8 | mouth: string; 9 | } 10 | 11 | export class FaceFactory { 12 | private colorHash: Hash; 13 | private eyeHash: Hash; 14 | private noseHash: Hash; 15 | private mouthHash: Hash; 16 | 17 | constructor( 18 | colors: string[], 19 | eyes: string[], 20 | noses: string[], 21 | mouths: string[], 22 | ) { 23 | this.colorHash = new Hash(colors); 24 | this.eyeHash = new Hash(eyes); 25 | this.noseHash = new Hash(noses); 26 | this.mouthHash = new Hash(mouths, hashFactory(sumAndDiff)); 27 | } 28 | 29 | public create(string): Face { 30 | return { 31 | color: this.colorHash.get(string), 32 | eyes: this.eyeHash.get(string), 33 | nose: this.noseHash.get(string), 34 | mouth: this.mouthHash.get(string), 35 | }; 36 | } 37 | } 38 | 39 | const defaultColors = [ 40 | '#81bef1', 41 | '#ad8bf2', 42 | '#bff288', 43 | '#de7878', 44 | '#a5aac5', 45 | '#6ff2c5', 46 | '#f0da5e', 47 | '#eb5972', 48 | '#f6be5d', 49 | ]; 50 | 51 | export default new FaceFactory( 52 | defaultColors, 53 | eyeImages, 54 | noseImages, 55 | mouthImages, 56 | ); 57 | -------------------------------------------------------------------------------- /src/lib/imageFiles.ts: -------------------------------------------------------------------------------- 1 | import path from 'path'; 2 | import { filePaths, fileNames } from 'avatars-utils'; 3 | import { Face } from './FaceFactory'; 4 | 5 | const imageDir = path.join(__dirname, '..', 'img'); 6 | 7 | export const imageFilePaths = (type: keyof Face): string[] => 8 | filePaths(path.join(imageDir, type)); 9 | 10 | export const imageFileNames = (type: keyof Face): string[] => 11 | fileNames(path.join(imageDir, type)); 12 | 13 | export const eyeImages = imageFilePaths('eyes'); 14 | export const noseImages = imageFilePaths('nose'); 15 | export const mouthImages = imageFilePaths('mouth'); 16 | -------------------------------------------------------------------------------- /src/lib/imaging.ts: -------------------------------------------------------------------------------- 1 | import sharp from 'sharp'; 2 | import { parseSizeFactory } from 'avatars-utils'; 3 | import { Face } from './FaceFactory'; 4 | 5 | const minSize = 40; 6 | const maxSize = 400; 7 | 8 | export const parseSize = parseSizeFactory(minSize, maxSize); 9 | 10 | export const combine = (face: Face) => 11 | sharp(face.eyes) 12 | .composite([{ input: face.mouth }, { input: face.nose }]) 13 | .flatten({ background: face.color }); 14 | 15 | export const resize = (rawSize: string) => { 16 | const size = parseSize(rawSize); 17 | return sharp().resize(size.width, size.height); 18 | }; 19 | -------------------------------------------------------------------------------- /src/router/index.ts: -------------------------------------------------------------------------------- 1 | import Router, { Response } from 'express'; 2 | import uuid from 'uuid'; 3 | 4 | import { imageFileNames, imageFilePaths } from '../lib/imageFiles'; 5 | import { combine, resize } from '../lib/imaging'; 6 | import FaceFactory, { Face } from '../lib/FaceFactory'; 7 | 8 | const imageTypes: Array = ['eyes', 'nose', 'mouth']; 9 | 10 | const router = Router(); 11 | 12 | const pngResponse = (response: Response) => { 13 | response.setHeader('Expires', new Date(Date.now() + 604800000).toUTCString()); 14 | return response.type('image/png'); 15 | }; 16 | 17 | router.get('/list', (req, res) => { 18 | const face = {}; 19 | imageTypes.forEach(type => (face[type] = imageFileNames(type))); 20 | 21 | res.set('Content-Type', 'application/json').send({ face }); 22 | }); 23 | 24 | router.get('/:size?/random', (req, res) => { 25 | const { size } = req.params; 26 | const face = FaceFactory.create(uuid.v4()); 27 | 28 | combine(face) 29 | .png() 30 | .pipe(resize(size)) 31 | .pipe(pngResponse(res)); 32 | }); 33 | 34 | router.get('/:size?/:id', (req, res, next) => { 35 | const { id, size } = req.params; 36 | const face = FaceFactory.create(id); 37 | 38 | combine(face) 39 | .png() 40 | .pipe(resize(size)) 41 | .pipe(pngResponse(res)); 42 | }); 43 | 44 | router.get('/face/:eyes/:nose/:mouth/:color/:size?', (req, res, next) => { 45 | const { color, size } = req.params; 46 | const face = { color: `#${color}` } as Face; 47 | 48 | imageTypes.forEach(type => { 49 | const requestedName = req.params[type]; 50 | const paths = imageFilePaths(type); 51 | face[type] = paths.find(path => !!path.match(requestedName)) || paths[0]; 52 | 53 | if (requestedName === 'x') { 54 | face[type] = ''; 55 | } 56 | }); 57 | 58 | combine(face) 59 | .png() 60 | .pipe(resize(size)) 61 | .pipe(pngResponse(res)); 62 | }); 63 | 64 | export default router; 65 | -------------------------------------------------------------------------------- /test/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsthatguy/avatars-api-middleware/89f269b349e6039f9579b403679a249c2e8fdcd9/test/favicon.ico -------------------------------------------------------------------------------- /test/integration.test.ts: -------------------------------------------------------------------------------- 1 | import supertest from 'supertest'; 2 | import { expect } from 'chai'; 3 | import server from './server'; 4 | import sharp = require('sharp'); 5 | 6 | describe('middleware', () => { 7 | let metaReader: sharp.Sharp; 8 | 9 | beforeEach(() => { 10 | metaReader = sharp(); 11 | }); 12 | 13 | describe('v2 avatar request', () => { 14 | it('responds with an image', done => { 15 | supertest(server) 16 | .get('/avatars/abott') 17 | .expect('Content-Type', /image/) 18 | .end(done); 19 | }); 20 | 21 | it('can resize an image', done => { 22 | supertest(server) 23 | .get('/avatars/220/abott') 24 | .pipe(metaReader); 25 | 26 | metaReader 27 | .metadata() 28 | .then(meta => { 29 | expect(meta.height).to.eql(220); 30 | expect(meta.width).to.eql(220); 31 | done(); 32 | }) 33 | .catch(done); 34 | }); 35 | 36 | it('can manually compose an image', done => { 37 | supertest(server) 38 | .get('/avatars/face/eyes1/nose4/mouth11/bbb') 39 | .expect(200) 40 | .expect('Content-Type', /image/) 41 | .end(done); 42 | }); 43 | 44 | it('can manually compose an image with a custom size', done => { 45 | supertest(server) 46 | .get('/avatars/face/eyes1/nose4/mouth11/bbb/50') 47 | .expect(200) 48 | .expect('Content-Type', /image/) 49 | .pipe(metaReader); 50 | 51 | metaReader 52 | .metadata() 53 | .then(meta => { 54 | expect(meta.height).to.eql(50); 55 | expect(meta.width).to.eql(50); 56 | done(); 57 | }) 58 | .catch(done); 59 | }); 60 | }); 61 | 62 | describe('v2 avatar list requests', () => { 63 | it('responds with json', done => { 64 | supertest(server) 65 | .get('/avatars/list') 66 | .expect('Content-Type', /json/) 67 | .end(done); 68 | }); 69 | 70 | it('responds with a list of possible face parts', done => { 71 | supertest(server) 72 | .get('/avatars/list') 73 | .end((err, res) => { 74 | const faceParts = res.body.face; 75 | expect(faceParts).to.have.keys('eyes', 'mouth', 'nose'); 76 | done(); 77 | }); 78 | }); 79 | }); 80 | 81 | describe('v2 avatar random requests', () => { 82 | it('can randomly generate a new avatar', done => { 83 | const getRandom = () => 84 | supertest(server) 85 | .get('/avatars/random') 86 | .expect(200) 87 | .expect('Content-Type', /image/); 88 | const metaReader2 = sharp(); 89 | 90 | getRandom().pipe(metaReader); 91 | getRandom().pipe(metaReader2); 92 | 93 | Promise.all([metaReader.metadata(), metaReader2.metadata()]) 94 | .then(([meta, meta2]) => { 95 | expect(meta.size).not.to.equal(meta2.size); 96 | done(); 97 | }) 98 | .catch(done); 99 | }); 100 | 101 | it('supports a custom size parameter', done => { 102 | supertest(server) 103 | .get('/avatars/50/random') 104 | .expect(200) 105 | .expect('Content-Type', /image/) 106 | .pipe(metaReader); 107 | 108 | metaReader 109 | .metadata() 110 | .then(meta => { 111 | expect(meta.height).to.eql(50); 112 | expect(meta.width).to.eql(50); 113 | done(); 114 | }) 115 | .catch(done); 116 | }); 117 | }); 118 | }); 119 | -------------------------------------------------------------------------------- /test/mocha.opts: -------------------------------------------------------------------------------- 1 | --require ts-node/register 2 | --recursive 3 | --reporter spec 4 | test/**/*.test.ts 5 | -------------------------------------------------------------------------------- /test/server.ts: -------------------------------------------------------------------------------- 1 | import express from 'express'; 2 | import path from 'path'; 3 | import favicon from 'serve-favicon'; 4 | 5 | import avatarsRouter from '../src/router'; 6 | 7 | const app = express(); 8 | const port = Number(process.env.PORT) || 3002; 9 | 10 | const faviconPath = path.join(__dirname, 'favicon.ico'); 11 | app.use(favicon(faviconPath)); 12 | 13 | app.use('/avatars', avatarsRouter); 14 | 15 | app.listen(port, () => 16 | console.log(`[Adorable Avatars] Running at: http://localhost:${port}`), 17 | ); 18 | 19 | export default app; 20 | -------------------------------------------------------------------------------- /test/tslint.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../tslint.json", 3 | "rules": { 4 | "no-implicit-dependencies": [true, "dev"] 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "module": "commonjs", 4 | "declaration": true, 5 | "esModuleInterop": true, 6 | "target": "es6", 7 | "noImplicitAny": false, 8 | "moduleResolution": "node", 9 | "outDir": "dist", 10 | "baseUrl": "." 11 | }, 12 | "include": ["src/**/*"] 13 | } 14 | -------------------------------------------------------------------------------- /tslint.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": ["tslint:latest", "tslint-config-prettier"], 3 | "rulesDirectory": ["tslint-plugin-prettier"], 4 | "rules": { 5 | "prettier": true, 6 | "no-console": [false], 7 | "quotemark": [true, "single"], 8 | "semicolon": [true, "always", "ignore-bound-class-methods"], 9 | "trailing-comma": [ 10 | true, 11 | { 12 | "multiline": "always", 13 | "singleline": "never" 14 | } 15 | ], 16 | "only-arrow-functions": [true, "allow-named-functions"], 17 | "arrow-parens": false, 18 | "variable-name": [ 19 | true, 20 | "check-format", 21 | "allow-pascal-case", 22 | "allow-leading-underscore" 23 | ], 24 | "switch-default": false, 25 | "member-access": false, 26 | "ordered-imports": [false], 27 | "object-literal-sort-keys": false, 28 | "no-unused-expression": [ 29 | true, 30 | "allow-fast-null-checks", 31 | "allow-tagged-template" 32 | ], 33 | "no-shadowed-variable": [true, { "underscore": false }], 34 | "max-classes-per-file": [true, 1], 35 | "object-literal-key-quotes": [true, "as-needed"], 36 | "interface-over-type-literal": false, 37 | "no-object-literal-type-assertion": false, 38 | "member-ordering": [ 39 | true, 40 | { 41 | "order": "statics-first" 42 | } 43 | ], 44 | "no-submodule-imports": false, 45 | "interface-name": [true, "never-prefix"] 46 | } 47 | } 48 | --------------------------------------------------------------------------------