├── .flowconfig ├── .gitignore ├── .jscs.json ├── .jshintrc ├── .npmignore ├── LICENSE ├── Makefile ├── README.md ├── bin └── pboard.njs ├── misc ├── flow.js └── xlsx.js ├── package.json └── pb.js /.flowconfig: -------------------------------------------------------------------------------- 1 | [ignore] 2 | .*/node_modules/.* 3 | 4 | [include] 5 | pb.js 6 | 7 | [libs] 8 | misc/flow.js 9 | 10 | [options] 11 | module.file_ext=.js 12 | module.file_ext=.njs 13 | module.ignore_non_literal_requires=true 14 | suppress_comment= \\(.\\|\n\\)*\\$FlowIgnore 15 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | -------------------------------------------------------------------------------- /.jscs.json: -------------------------------------------------------------------------------- 1 | { 2 | "requireCommaBeforeLineBreak": true, 3 | "disallowTrailingWhitespace": true, 4 | "disallowTrailingComma": true 5 | } 6 | 7 | -------------------------------------------------------------------------------- /.jshintrc: -------------------------------------------------------------------------------- 1 | { 2 | "bitwise": false, 3 | "curly": false 4 | } 5 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | misc/ 2 | node_modules 3 | *.tgz 4 | .gitignore 5 | .eslintrc 6 | .jshintrc 7 | Makefile 8 | .npmignore 9 | .jscs.json 10 | .flowconfig 11 | -------------------------------------------------------------------------------- /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 (C) 2013-present SheetJS LLC 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 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | LIB=pb 2 | REQS= 3 | ADDONS= 4 | AUXTARGETS= 5 | 6 | ULIB=$(shell echo $(LIB) | tr a-z A-Z) 7 | DEPS= 8 | TARGET=$(LIB).js 9 | 10 | .PHONY: lint 11 | lint: $(TARGET) $(AUXTARGETS) 12 | jshint --show-non-errors $(TARGET) $(AUXTARGETS) 13 | jshint --show-non-errors package.json 14 | jscs $(TARGET) $(AUXTARGETS) 15 | 16 | .PHONY: flow 17 | flow: lint 18 | flow check --all --show-all-errors 19 | 20 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # pb 2 | 3 | Improved pbcopy/pbpaste for OSX 4 | 5 | The standard pbcopy and pbpaste utilities can manipulate the plaintext clipboard 6 | but have no easy way of accessing the HTML pasteboard. This module and CLI tool 7 | provide a more convenient way to access the pasteboard from node. 8 | 9 | 10 | ## Command-Line Tool Usage 11 | 12 | To get data from a specific pasteboard: 13 | 14 | ```bash 15 | $ npx pb [type] 16 | $ npx pb -m 17 | ``` 18 | 19 | To set a specific pasteboard, pipe data into pb: 20 | 21 | ```bash 22 | $ get_data | npx pb -s [type] 23 | ``` 24 | 25 | To list available pasteboards: 26 | 27 | ```bash 28 | $ npx pb -l 29 | ``` 30 | 31 | For example, to grab the contents of the HTML pasteboard and put it on the 32 | plaintext pasteboard: 33 | 34 | ```bash 35 | $ npx pb -m html | npx pb -s 36 | ``` 37 | 38 | 39 | ## Library Usage 40 | 41 | From node, `pb` exposes: 42 | 43 | - `get(type)`: get pasteboard data from specified pasteboard 44 | - `set(type, data)`: set pasteboard data (overwrites other pasteboards) 45 | - `available()`: enumerate available pasteboards 46 | 47 | This example gets the pasteboard HTML data and copies to plaintext pasteboard: 48 | 49 | ```js 50 | var pb = require('pb'); 51 | var HTMLOutput = pb.get('html'); 52 | pb.set('text', HTMLOutput); 53 | ``` 54 | 55 | 56 | ## Supported Pasteboards 57 | 58 | | type | description | 59 | |:---------------------|:------------| 60 | | `NSStringPboardType` | plaintext | 61 | | `NSHTMLPboardType` | HTML | 62 | | `NSRTFPboardType` | RTF | 63 | 64 | 65 | ## License 66 | 67 | Please consult the attached LICENSE file for details. All rights not explicitly 68 | granted by the Apache 2.0 license are reserved by the Original Author. 69 | 70 | [![Analytics](https://ga-beacon.appspot.com/UA-36810333-1/SheetJS/pb?pixel)](https://github.com/SheetJS/pb) 71 | -------------------------------------------------------------------------------- /bin/pboard.njs: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | /* pb.js (C) 2013-present SheetJS -- http://sheetjs.com */ 3 | var n = "pb"; 4 | /* vim: set ts=2 ft=javascript: */ 5 | var X = require('../'); 6 | var program = require('command'+'er'); 7 | program 8 | .version(X.version) 9 | .usage('[options] [mode]') 10 | .option('-m, --mode ', 'use specified mode (default text)') 11 | .option('-l, --list-modes', 'list available modes') 12 | .option('-s, --set', 'read from stdin and set the specified clipboard'); 13 | 14 | program.on('--help', function() { 15 | console.log(' Support email: dev@sheetjs.com'); 16 | }); 17 | 18 | program.parse(process.argv); 19 | 20 | var type = program.mode || program.args[0] || 'text'; 21 | if(!X.mytype(type)[0]) throw new Error("Unsupported type " + type); 22 | 23 | if(program.listModes) { console.log(X.available().join("\n")); process.exit(0); } 24 | if(program.set) { 25 | var data = ""; 26 | process.stdin.on('data', function(d) { data += d; }); 27 | process.stdin.on('end', function() { X.set(type, data);}); 28 | process.stdin.resume(); 29 | } else { 30 | process.stdout.write(String(X.get(type))); 31 | if(process.stdout.isTTY) process.stdout.write("\n"); 32 | } 33 | -------------------------------------------------------------------------------- /misc/flow.js: -------------------------------------------------------------------------------- 1 | /*:: 2 | declare module 'nodobjc' { declare var exports:any; } 3 | */ 4 | -------------------------------------------------------------------------------- /misc/xlsx.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | /* pb.js -- (C) 2013-present SheetJS -- http://sheetjs.com */ 3 | /* vim: set ts=2: */ 4 | /*jshint node:true */ 5 | var PB = require('../'), fs = require('fs'); 6 | 7 | /* generate RTF */ 8 | var XLSX = require('xlsx'); 9 | var wb = XLSX.utils.book_new(); 10 | var ws = XLSX.utils.aoa_to_sheet([["Sheet", "JS"],[1,2,3,4]]); 11 | XLSX.utils.book_append_sheet(wb, ws, "SheetJS"); 12 | var RTF = XLSX.write(wb, {type:'binary', bookType:'rtf'}); 13 | 14 | /* copy to pasteboard */ 15 | PB.set('RTF', RTF); 16 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "pb", 3 | "version": "0.4.0", 4 | "author": "SheetJS", 5 | "description": "Interface to OSX Pasteboard", 6 | "keywords": [ 7 | "osx", 8 | "mac", 9 | "pasteboard", 10 | "clipboard" 11 | ], 12 | "bin": { 13 | "pb": "./bin/pboard.njs" 14 | }, 15 | "main": "pb.js", 16 | "dependencies": { 17 | "commander": "~2.17.1", 18 | "objc": "" 19 | }, 20 | "repository": { 21 | "type": "git", 22 | "url": "git://github.com/SheetJS/pb.git" 23 | }, 24 | "bugs": { 25 | "url": "https://github.com/SheetJS/pb/issues" 26 | }, 27 | "license": "Apache-2.0", 28 | "engines": { 29 | "node": ">=10.0" 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /pb.js: -------------------------------------------------------------------------------- 1 | /* pb.js -- (C) 2013-present SheetJS -- http://sheetjs.com */ 2 | /* vim: set ts=2: */ 3 | /*jshint node:true */ 4 | const objc = require('objc'); 5 | objc.import('AppKit'); 6 | 7 | const { 8 | NSPasteboard, 9 | NSPasteboardTypeHTML, 10 | NSPasteboardTypePNG, 11 | NSPasteboardTypeRTF, 12 | NSPasteboardTypeString, 13 | } = objc; 14 | 15 | exports.version = '0.4.0'; 16 | 17 | var mytype = exports.mytype = function mytype(type/*:string*/)/*:Array*/ { 18 | if(!type) return [NSPasteboardTypeString, 's']; 19 | switch(type.toUpperCase()) { 20 | case 'HTML': return [NSPasteboardTypeHTML, 's']; 21 | case 'PNG': return [NSPasteboardTypePNG, 'i']; 22 | case 'TEXT': return [NSPasteboardTypeString, 's']; 23 | case 'RTF': return [NSPasteboardTypeRTF, 's']; 24 | } 25 | try { 26 | return [objc[type], 's']; 27 | } catch(e) { return [type, 's']; } 28 | }; 29 | 30 | exports.get = function get(type/*:string*/)/*:any*/ { 31 | const gp = NSPasteboard.generalPasteboard(); 32 | var tt = mytype(type), t = tt[0], o = tt[1]; 33 | 34 | switch(o) { 35 | case 's': return objc.js(gp.stringForType(t)); 36 | case 'i': { 37 | throw new Error("Unsupported images"); 38 | } 39 | } 40 | throw new Error("Cannot process pasteboard data"); 41 | }; 42 | 43 | exports.set = function set(type/*:string*/, str/*:string*/)/*:boolean*/ { 44 | var gp = NSPasteboard.generalPasteboard(); 45 | var tt = mytype(type); 46 | var t = tt[0], o = tt[1], data; 47 | gp.clearContents(); 48 | switch(o) { 49 | case 's': 50 | return gp.setString_forType(str, t); 51 | } 52 | return false; 53 | }; 54 | 55 | exports.available = function avail()/*:Array*/ { 56 | const gp = NSPasteboard.generalPasteboard(); 57 | const types = gp.types(); 58 | const out = []; 59 | const len = types.count(); 60 | for(let i = 0; i < len; ++i) out[i] = objc.js(types.objectAtIndex(i)); 61 | return out; 62 | }; 63 | --------------------------------------------------------------------------------