├── .cargo-ok ├── .gitignore ├── fonts ├── OpenSans-Regular.ttf └── Inconsolata-Medium.ttf ├── tests └── web.rs ├── src ├── utils.rs └── lib.rs ├── README.md ├── LICENSE_MIT ├── Cargo.toml └── LICENSE_APACHE /.cargo-ok: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | **/*.rs.bk 3 | Cargo.lock 4 | bin/ 5 | pkg/ 6 | wasm-pack.log 7 | -------------------------------------------------------------------------------- /fonts/OpenSans-Regular.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/alessbell/wasm-twitter-card/HEAD/fonts/OpenSans-Regular.ttf -------------------------------------------------------------------------------- /fonts/Inconsolata-Medium.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/alessbell/wasm-twitter-card/HEAD/fonts/Inconsolata-Medium.ttf -------------------------------------------------------------------------------- /tests/web.rs: -------------------------------------------------------------------------------- 1 | //! Test suite for the Web and headless browsers. 2 | 3 | #![cfg(target_arch = "wasm32")] 4 | 5 | extern crate wasm_bindgen_test; 6 | use wasm_bindgen_test::*; 7 | 8 | wasm_bindgen_test_configure!(run_in_browser); 9 | 10 | #[wasm_bindgen_test] 11 | fn pass() { 12 | assert_eq!(1 + 1, 2); 13 | } 14 | -------------------------------------------------------------------------------- /src/utils.rs: -------------------------------------------------------------------------------- 1 | pub fn set_panic_hook() { 2 | // When the `console_error_panic_hook` feature is enabled, we can call the 3 | // `set_panic_hook` function at least once during initialization, and then 4 | // we will get better error messages if our code ever panics. 5 | // 6 | // For more details see 7 | // https://github.com/rustwasm/console_error_panic_hook#readme 8 | #[cfg(feature = "console_error_panic_hook")] 9 | console_error_panic_hook::set_once(); 10 | } 11 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## wasm-twitter-card 2 | 3 | A humble pre-release library that does one thing only: provides a `generate_text` function for creating a twitter card-size image (630 x 1200 px) returned as a Uint8Array of pixels. 4 | 5 | `generate_text` accepts two arguments: a title and author. It creates an image with white monospace text with an empty background, e.g.: 6 | 7 | ![gatsby-remark-twitter-cards in action](https://i.imgur.com/UGFRs9g.png) 8 | 9 | It was made for the use case described in [`gatsby-remark-twitter-cards`](https://github.com/alessbell/gatsby-remark-twitter-cards). 10 | 11 | ## Contributing 12 | 13 | Contributions are warmly welcome! Upon cloning this repo, you can run the command `wasm-pack build --target nodejs` to build from `src`. 14 | 15 | ## Roadmap 16 | 17 | - [x] Custom font 18 | - [x] Prints title and subtitle 19 | - [x] Choice of font family (monospace, sans serif) 20 | - [x] Custom font color 21 | - [x] Custom title font size 22 | - [x] Custom subtitle font size 23 | -------------------------------------------------------------------------------- /LICENSE_MIT: -------------------------------------------------------------------------------- 1 | Copyright (c) 2018 Alessia Bellisario 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 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "wasm-twitter-card" 3 | version = "0.3.0" 4 | authors = ["Alessia Bellisario "] 5 | edition = "2018" 6 | 7 | [lib] 8 | crate-type = ["cdylib", "rlib"] 9 | 10 | [features] 11 | default = ["console_error_panic_hook"] 12 | 13 | [dependencies] 14 | wasm-bindgen = "0.2" 15 | rusttype = "0.8.2" 16 | image = { version = "0.22", default-features = false, features = ["png_codec"] } 17 | glyph_brush_layout = "0.1.8" 18 | serde-wasm-bindgen = "0.1.3" 19 | js-sys = "0.3.33" 20 | 21 | # The `console_error_panic_hook` crate provides better debugging of panics by 22 | # logging them with `console.error`. This is great for development, but requires 23 | # all the `std::fmt` and `std::panicking` infrastructure, so isn't great for 24 | # code size when deploying. 25 | console_error_panic_hook = { version = "0.1.1", optional = true } 26 | 27 | # `wee_alloc` is a tiny allocator for wasm that is only ~1K in code size 28 | # compared to the default allocator's ~10K. It is slower than the default 29 | # allocator, however. 30 | # 31 | # Unfortunately, `wee_alloc` requires nightly Rust when targeting wasm for now. 32 | wee_alloc = { version = "0.4.2", optional = true } 33 | 34 | [dependencies.web-sys] 35 | version = "0.3.4" 36 | features = [ 37 | 'console', 38 | 'Node', 39 | ] 40 | 41 | [dev-dependencies] 42 | wasm-bindgen-test = "0.2" 43 | 44 | [profile.release] 45 | # Tell `rustc` to optimize for small code size. 46 | opt-level = "s" 47 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | mod utils; 2 | use glyph_brush_layout::{ 3 | rusttype::{Font, Scale}, 4 | *, 5 | }; 6 | use image::{DynamicImage, Rgba}; 7 | use js_sys::Uint8Array; 8 | use serde_wasm_bindgen; 9 | use wasm_bindgen::prelude::*; 10 | 11 | // When the `wee_alloc` feature is enabled, use `wee_alloc` as the global 12 | // allocator. 13 | #[cfg(feature = "wee_alloc")] 14 | #[global_allocator] 15 | static ALLOC: wee_alloc::WeeAlloc = wee_alloc::WeeAlloc::INIT; 16 | 17 | // A macro to provide `println!(..)`-style syntax for `console.log` logging. 18 | macro_rules! log { 19 | ( $( $t:tt )* ) => { 20 | web_sys::console::log_1(&format!( $( $t )* ).into()); 21 | } 22 | } 23 | 24 | #[wasm_bindgen] 25 | pub fn generate_text( 26 | title: &str, 27 | author: &str, 28 | title_font_size: i32, 29 | subtitle_font_size: i32, 30 | rgb: JsValue, 31 | font_style: &str, 32 | font_file: Uint8Array, 33 | ) -> Vec { 34 | utils::set_panic_hook(); 35 | const WIDTH: f32 = 1200.0; 36 | const HEIGHT: f32 = 630.0; 37 | const PADDING: f32 = 50.0; 38 | 39 | let rgb_value: (u8, u8, u8) = serde_wasm_bindgen::from_value(rgb).unwrap(); 40 | 41 | let font = if font_style == "monospace" { 42 | Font::from_bytes(&include_bytes!("../fonts/Inconsolata-Medium.ttf")[..]) 43 | .expect("Error constructing Font") 44 | } else if font_style == "sans-serif" { 45 | Font::from_bytes(&include_bytes!("../fonts/OpenSans-Regular.ttf")[..]) 46 | .expect("Error constructing Font") 47 | } else { 48 | // take font binary passed in as Uint8Array and copy the contents into a new vec 49 | let user_font = font_file.to_vec(); 50 | Font::from_bytes(user_font).expect("Error constructing Font") 51 | }; 52 | 53 | let fonts = vec![font]; 54 | let bounds = (WIDTH - (PADDING * 2.0), HEIGHT - (PADDING * 2.0)); 55 | 56 | let title_glyphs: Vec<_> = Layout::default().calculate_glyphs( 57 | &fonts, 58 | &SectionGeometry { 59 | screen_position: (PADDING, PADDING), 60 | bounds: bounds, 61 | }, 62 | &[SectionText { 63 | text: title, 64 | scale: Scale::uniform(title_font_size as f32), 65 | font_id: FontId(0), 66 | color: [0.0, 1.0, 0.0, 1.0], 67 | }], 68 | ); 69 | 70 | let author_glyphs: Vec<_> = Layout::default().calculate_glyphs( 71 | &fonts, 72 | &SectionGeometry { 73 | screen_position: (PADDING, HEIGHT - PADDING - subtitle_font_size as f32), 74 | bounds: bounds, 75 | }, 76 | &[SectionText { 77 | text: author, 78 | scale: Scale::uniform(subtitle_font_size as f32), 79 | font_id: FontId(0), 80 | color: [0.0, 1.0, 0.0, 1.0], 81 | }], 82 | ); 83 | 84 | // Create a new rgba image 85 | let mut image = DynamicImage::new_rgba8(WIDTH as u32, HEIGHT as u32).to_rgba(); 86 | 87 | for glyph in title_glyphs { 88 | if let Some(bounding_box) = glyph.0.pixel_bounding_box() { 89 | glyph.0.draw(|x, y, v| { 90 | image.put_pixel( 91 | // Offset the position by the glyph bounding box 92 | x + bounding_box.min.x as u32, 93 | y + bounding_box.min.y as u32, 94 | Rgba([rgb_value.0, rgb_value.1, rgb_value.2, (v * 255.0) as u8]), 95 | ) 96 | }); 97 | } 98 | } 99 | 100 | for glyph in author_glyphs { 101 | if let Some(bounding_box) = glyph.0.pixel_bounding_box() { 102 | glyph.0.draw(|x, y, v| { 103 | image.put_pixel( 104 | // Offset the position by the glyph bounding box 105 | x + bounding_box.min.x as u32, 106 | y + bounding_box.min.y as u32, 107 | Rgba([rgb_value.0, rgb_value.1, rgb_value.2, (v * 255.0) as u8]), 108 | ) 109 | }); 110 | } 111 | } 112 | 113 | return image.to_vec(); 114 | } 115 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------