├── ISSUE_TEMPLATE.md ├── package.json ├── PULL_REQUEST_TEMPLATE.md ├── README.md ├── lib ├── index.js ├── manifest.js └── dialogs.js ├── .gitignore ├── CONTRIBUTING.md ├── CODE_OF_CONDUCT.md └── LICENSE /ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | # Submit an issue 2 | 3 | ## Topic 4 | 5 | This is an issue regarding: 6 | 7 | - [ ] The guides contained within this repo. 8 | - [ ] The samples contained within this repo. 9 | 10 | 11 | ## Versions 12 | 13 | - [ ] Supported XD version(s): 14 | 15 | 16 | ## Description of the issue 17 | 18 | 19 | ## Proposed solution or attempted solutions that failed 20 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@adobe/xd-plugin-toolkit", 3 | "version": "0.0.1", 4 | "description": "Adobe XD Plugin Helper Library", 5 | "main": "lib/index.js", 6 | "scripts": { 7 | "publish": "echo use: yarn publish --access public" 8 | }, 9 | "repository": "https://github.com/AdobeXD/plugin-toolkit.git", 10 | "author": "Kerri Shotts", 11 | "license": "Apache-2.0" 12 | } 13 | -------------------------------------------------------------------------------- /PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | # Submit a pull request 2 | 3 | ## CLA 4 | 5 | - [ ] I have signed the [Adobe CLA](http://adobe.github.io/cla.html) (required). 6 | 7 | ## Topic 8 | 9 | This is a pull request for: 10 | 11 | - [ ] A guide contained within this repo. 12 | - [ ] A sample contained within this repo. 13 | - [ ] Something new that I have already discussed with Adobe in a GitHub issue. Issue link: 14 | 15 | ## Versions 16 | 17 | - [ ] XD version(s) tested : 18 | - [ ] Tested XD version(s): 19 | 20 | ## Description of the pull request 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Adobe XD Plugin Helpers 2 | 3 | These helpers are designed to provide simplified access to certain APIs. 4 | 5 | ## Usage 6 | 7 | ### Copy 8 | 9 | Download the repository and copy the `lib` folder to your project. You can then reference desired utilities using `require('./lib/[module].js')`. 10 | 11 | ### Npm 12 | 13 | npm install @adobe/xd-plugin-toolkit 14 | 15 | ### Yarn 16 | 17 | yarn add @adobe/xd-plugin-toolkit 18 | 19 | ## Modules Included 20 | 21 | * `./lib/dialogs.js`: Provides useful functions for creating simple alerts, confirmation dialogs, prompts, and more, using the suggested design language. 22 | 23 | ## License 24 | 25 | Apache 2.0 26 | -------------------------------------------------------------------------------- /lib/index.js: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2018 Adobe Inc. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | const dialogs = require("./dialogs"); 18 | const manifest = require("./manifest"); 19 | 20 | module.exports = { 21 | dialogs, 22 | manifest 23 | }; -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | Thanks for choosing to contribute! 4 | 5 | The following are a set of guidelines to follow when contributing to this project. 6 | 7 | ## Code Of Conduct 8 | 9 | This project adheres to the Adobe [code of conduct](CODE_OF_CONDUCT.md). By participating, 10 | you are expected to uphold this code. Please report unacceptable behavior to 11 | [Grp-opensourceoffice@adobe.com](mailto:Grp-opensourceoffice@adobe.com). 12 | 13 | ## Have A Question? 14 | 15 | Start by filing an issue. The existing committers on this project work to reach 16 | consensus around project direction and issue solutions within issue threads 17 | (when appropriate). 18 | 19 | ## Contributor License Agreement 20 | 21 | All third-party contributions to this project must be accompanied by a signed contributor 22 | license agreement. This gives Adobe permission to redistribute your contributions 23 | as part of the project. [Sign our CLA](http://opensource.adobe.com/cla.html). You 24 | only need to submit an Adobe CLA one time, so if you have submitted one previously, 25 | you are good to go! 26 | 27 | ## Code Reviews 28 | 29 | All submissions should come in the form of pull requests and need to be reviewed 30 | by project committers. Read [GitHub's pull request documentation](https://help.github.com/articles/about-pull-requests/) 31 | for more information on sending pull requests. 32 | 33 | Lastly, please follow the [pull request template](PULL_REQUEST_TEMPLATE.md) when 34 | submitting a pull request! 35 | 36 | ## From Contributor To Committer 37 | 38 | We love contributions from our community! If you'd like to go a step beyond contributor 39 | and become a committer with full write access and a say in the project, you must 40 | be invited to the project. The existing committers employ an internal nomination 41 | process that must reach lazy consensus (silence is approval) before invitations 42 | are issued. If you feel you are qualified and want to get more deeply involved, 43 | feel free to reach out to existing committers to have a conversation about that. 44 | 45 | ## Security Issues 46 | 47 | Security issues shouldn't be reported on this issue tracker. Instead, [file an issue to our security experts](https://helpx.adobe.com/security/alertus.html) 48 | -------------------------------------------------------------------------------- /lib/manifest.js: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2018 Adobe Inc. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | let manifest; 18 | 19 | /** 20 | * Reads the plugin's manifest and returns the parsed contents. 21 | * 22 | * Throws if the manifest is invalid or doesn't exist. 23 | * 24 | * Note: Reads manifest only once. Future calls will not reload 25 | * the manifest file. 26 | */ 27 | async function getManifest() { 28 | if (!manifest) { 29 | const fs = require("uxp").storage.localFileSystem; 30 | const dataFolder = await fs.getPluginFolder(); 31 | const manifestFile = await dataFolder.getEntry("manifest.json"); 32 | if (manifestFile) { 33 | const json = await manifestFile.read(); 34 | manifest = JSON.parse(json); 35 | } 36 | } 37 | return manifest; 38 | } 39 | 40 | /** 41 | * Return the icon path that can fit the requested size without upscaling. 42 | * 43 | * @param {*} manifest 44 | * @param {number} size 45 | * @returns {string} path to the icon 46 | */ 47 | function getNearestIcon(manifest, size) { 48 | if (!manifest) { 49 | return; 50 | } 51 | 52 | if (manifest.icons) { 53 | // icons is an array of objects of the form 54 | // { width, height, path } 55 | 56 | // icons are assumed to be square, so we'll sort descending on the width 57 | const sortedIcons = manifest.icons.sort((a, b) => { 58 | const iconAWidth = a.width; 59 | const iconBWidth = b.width; 60 | return iconAWidth < iconBWidth ? 1 : iconAWidth > iconBWidth ? -1 : 0; 61 | }); 62 | 63 | // next, search until we find an icon _too_ small for the desired size 64 | const icon = sortedIcons.reduce((last, cur) => { 65 | if (!last) { 66 | last = cur; 67 | } else { 68 | if (cur.width >= size) { 69 | last = cur; 70 | } 71 | } 72 | return last; 73 | }); 74 | 75 | return icon.path; 76 | } 77 | } 78 | 79 | module.exports = { 80 | getManifest, 81 | getNearestIcon 82 | } -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Adobe 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, gender identity and expression, level of experience, 9 | nationality, personal appearance, race, religion, or sexual identity and 10 | 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 Grp-opensourceoffice@adobe.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 [http://contributor-covenant.org/version/1/4][version] 72 | 73 | [homepage]: http://contributor-covenant.org 74 | [version]: http://contributor-covenant.org/version/1/4/ 75 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /lib/dialogs.js: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2018 Adobe Inc. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | const {getManifest, getNearestIcon} = require('./manifest.js'); 18 | 19 | let manifest; 20 | 21 | /** 22 | * Converts a string (or an array of strings or other objects) to a nicer HTML 23 | * representation. Essentially this is a _very_ basic markdown parser. 24 | * 25 | * The following tokens are understood, when encountered at the beginning of 26 | * a string: 27 | * 28 | * Token | Result 29 | * -------------|----------------------- 30 | * `##` | `

` 31 | * `###` | `

` 32 | * `* ` | Bulleted list 33 | * `----` | `
` 34 | * `---` | `
` 35 | * `[...](href)`| `

...

` 36 | * 37 | * @param {string | string[] | * | Array<*>} str 38 | * @returns {string} the HTML representation 39 | */ 40 | function strToHtml(str) { 41 | // allow some common overloads, including arrays and non-strings 42 | if (Array.isArray(str)) { 43 | return str.map(str => strToHtml(str)).join(''); 44 | } 45 | if (typeof str !== 'string') { 46 | return strToHtml(`${str}`); 47 | } 48 | 49 | let html = str; 50 | 51 | // handle some markdown stuff 52 | if (html.substr(0, 2) === '##') { 53 | html = `

${html.substr(2).trim().toUpperCase()}

`; 54 | } else if (html.substr(0, 1) === '#') { 55 | html = `

${html.substr(1).trim()}

`; 56 | } else if (html.substr(0, 2) === '* ') { 57 | html = `

•${html.substr(2).trim()}

`; 58 | } else if (html.substr(0, 4) === '----') { 59 | html = `
${html.substr(5).trim()}`; 60 | } else if (html.substr(0, 3) === '---') { 61 | html = `
${html.substr(4).trim()}`; 62 | } else { 63 | html = `

${html.trim()}

`; 64 | } 65 | 66 | // handle links -- the catch here is that the link will transform the entire paragraph! 67 | const regex = /\[([^\]]*)\]\(([^\)]*)\)/; 68 | const matches = str.match(regex); 69 | if (matches) { 70 | const title = matches[1]; 71 | const url = matches[2]; 72 | html = `

${html.replace(regex, title).replace(/\<\|?p\>/g, '')}

`; 73 | } 74 | 75 | return html; 76 | } 77 | 78 | /* 79 | * Generates a "notice" dialog with the title, default icon, and a series of messages. 80 | * 81 | * @param {*} param 82 | * @property {string} param.title The dialog title 83 | * @property {string} [param.icon] The dialog icon to use. If not provided, no icon will be rendered 84 | * @property {string[]} param.msgs The messages to render. If a message starts with `http`, it will be rendered as a link. 85 | * @property {string} [param.prompt] If specified, will render as a prompt with a single input field and the prompt as a placeholder 86 | * @property {boolean} [param.multiline=false] If `true`, the prompt will render as a multi-line text field. 87 | * @property {boolean} [param.isError=false] If specified, will render the header in a red color 88 | * @property {Function} [param.render] If set, the results of this function (a DOM tree) will be appended into the content area of the dialog. 89 | * @property {Function} [param.template] If set, the results of this function (a string) will be appended into the content area of the dialog. 90 | * @property {Object[]} [buttons] Indicates the buttons to render. If none are specified, a `Close` button is rendered. 91 | * @returns {Promise} Resolves to an object of the form {which, value}. `value` only makes sense if `prompt` is set. `which` indicates which button was pressed. 92 | */ 93 | async function createDialog({ 94 | title, 95 | icon = 'plugin-icon', 96 | msgs, 97 | prompt, 98 | multiline = false, 99 | render, 100 | template, 101 | isError=false, 102 | buttons=[ 103 | {label: 'Close', variant: 'cta', type:'submit'} 104 | ]} = {}, 105 | width=360, 106 | height='auto', 107 | iconSize=18 108 | ) { 109 | 110 | let messages = Array.isArray(msgs) ? msgs : [ msgs ]; 111 | 112 | try { 113 | if (!manifest) { 114 | manifest = await getManifest(); 115 | } 116 | } catch (err) { 117 | // do nothing 118 | } 119 | 120 | let usingPluginIcon = false; 121 | if (icon === 'plugin-icon') { 122 | if (manifest.icons) { 123 | usingPluginIcon = true; 124 | iconSize = 24; 125 | icon = getNearestIcon(manifest, iconSize); 126 | } 127 | } 128 | 129 | const dialog = document.createElement('dialog'); 130 | dialog.innerHTML = ` 131 | 179 |
180 |

181 | ${title} 182 | ${icon ? `` : ''} 183 |

184 |
185 |
186 | ${ 187 | !render && ( 188 | template ? template() : ( 189 | messages.map(msg => strToHtml(msg)).join('') + 190 | (prompt ? `` : '') 195 | ) 196 | ) 197 | } 198 |
199 | 202 |
203 | `; 204 | 205 | // if render fn is passed, we'll call it and attach the DOM tree 206 | if (render) { 207 | dialog.querySelector(".container").appendChild(render()); 208 | } 209 | 210 | // The "ok" and "cancel" button indices. OK buttons are "submit" or "cta" buttons. Cancel buttons are "reset" buttons. 211 | let okButtonIdx = -1; 212 | let cancelButtonIdx = -1; 213 | let clickedButtonIdx = -1; 214 | 215 | // Ensure that the form can submit when the user presses ENTER (we trigger the OK button here) 216 | const form = dialog.querySelector('form'); 217 | form.onsubmit = () => dialog.close('ok'); 218 | 219 | // Attach button event handlers and set ok and cancel indices 220 | buttons.forEach(({type, variant} = {}, idx) => { 221 | const button = dialog.querySelector(`#btn${idx}`); 222 | if (type === 'submit' || variant === 'cta') { 223 | okButtonIdx = idx; 224 | } 225 | if (type === 'reset') { 226 | cancelButtonIdx = idx; 227 | } 228 | button.onclick = e => { 229 | e.preventDefault(); 230 | clickedButtonIdx = idx; 231 | dialog.close( idx === cancelButtonIdx ? 'reasonCanceled' : 'ok'); 232 | } 233 | }); 234 | 235 | try { 236 | document.appendChild(dialog); 237 | const response = await dialog.showModal(); 238 | if (response === 'reasonCanceled') { 239 | // user hit ESC 240 | return {which: cancelButtonIdx, value: ''}; 241 | } else { 242 | if (clickedButtonIdx === -1) { 243 | // user pressed ENTER, so no button was clicked! 244 | clickedButtonIdx = okButtonIdx; // may still be -1, but we tried 245 | } 246 | return {which: clickedButtonIdx, value: prompt ? dialog.querySelector('#prompt').value : ''}; 247 | } 248 | } catch(err) { 249 | // system refused the dialog 250 | return {which: cancelButtonIdx, value: ''}; 251 | } finally { 252 | dialog.remove(); 253 | } 254 | } 255 | 256 | /** 257 | * Generates an alert message 258 | * 259 | * @param {string} title 260 | * @param {string[]} msgs 261 | * @returns {Promise<{which: number}>} `which` indicates which button was clicked. 262 | */ 263 | async function alert(title, ...msgs) { 264 | return createDialog({title, msgs}); 265 | } 266 | 267 | /** 268 | * Generates a warning message 269 | * 270 | * @param {string} title 271 | * @param {string[]} msgs 272 | * @returns {Promise<{which: number}>} `which` indicates which button was clicked. 273 | */ 274 | async function error(title, ...msgs) { 275 | return createDialog({title, isError: true, msgs}); 276 | } 277 | 278 | /** 279 | * Displays a confirmation dialog. 280 | * 281 | * @param {string} title 282 | * @param {string} msg 283 | * @param {string[]} [buttons = ['Cancel', 'OK']] the buttons to display (in macOS order); TWO MAX. 284 | * @returns {Promise<{which: number}>} `which` indicates which button was clicked. 285 | */ 286 | async function confirm(title, msg, buttons = [ 'Cancel', 'OK' ]) { 287 | return createDialog({title, msgs: [msg], buttons: [ 288 | {label: buttons[0], type:'reset', variant: 'primary'}, 289 | {label: buttons[1], type:'submit', variant: 'cta'} 290 | ]}); 291 | } 292 | 293 | /** 294 | * Displays a warning dialog. 295 | * 296 | * @param {string} title 297 | * @param {string} msg 298 | * @param {string[]} [buttons = ['Cancel', 'OK']] the buttons to display (in macOS order); TWO MAX. 299 | * @returns {Promise<{which: number}>} `which` indicates which button was clicked. 300 | */ 301 | async function warning(title, msg, buttons = [ 'Cancel', 'OK' ]) { 302 | return createDialog({title, msgs: [msg], buttons: [ 303 | {label: buttons[0], type:'submit', variant: 'primary'}, 304 | {label: buttons[1], type:'button', variant: 'warning'} 305 | ]}); 306 | } 307 | 308 | /** 309 | * Displays a prompt dialog. 310 | * 311 | * @param {string} title 312 | * @param {string} msg 313 | * @param {string} prompt 314 | * @param {string[]} [buttons = ['Cancel', 'OK']] the buttons to display (in macOS order); TWO MAX. 315 | * @param {boolean} [multiline = false] If `true`, a multiline textarea will be used instead of a single line editor. 316 | * @returns {Promise<{which: number, value: string}>} `which` indicates which button was clicked, and `value` indicates the entered value in the text field. 317 | */ 318 | async function prompt(title, msg, prompt, buttons = [ 'Cancel', 'OK' ], multiline = false) { 319 | return createDialog({title, msgs: [msg], prompt, multiline, buttons: [ 320 | {label: buttons[0], type:'reset', variant: 'primary'}, 321 | {label: buttons[1], type:'submit', variant: 'cta'} 322 | ]}); 323 | } 324 | 325 | module.exports = { 326 | createDialog, 327 | alert, 328 | error, 329 | confirm, 330 | warning, 331 | prompt 332 | }; 333 | --------------------------------------------------------------------------------