@marktrue/dsh-mobile-remote 3.2.4-alpha.1 → 3.2.4-alpha.2-app

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (352) hide show
  1. package/DSH-Remote-v3.2.4.apk +4 -0
  2. package/README.md +6 -254
  3. package/manifest.json +21 -0
  4. package/package.json +12 -65
  5. package/CHANGELOG.md +0 -1410
  6. package/CONTRIBUTING.md +0 -59
  7. package/FAQ.md +0 -111
  8. package/cordis.patch.yml +0 -14
  9. package/docs/00-/345/274/200/345/217/221/346/200/273/347/272/262.md +0 -125
  10. package/docs/01-PRD.md +0 -148
  11. package/docs/02-architecture.md +0 -249
  12. package/docs/03-api.md +0 -1154
  13. package/docs/04-security.md +0 -100
  14. package/docs/05-test-cases.md +0 -405
  15. package/docs/06-install-run.md +0 -372
  16. package/docs/07-user-manual.md +0 -70
  17. package/docs/08-/346/211/251/345/261/225/345/274/200/345/217/221/346/214/207/345/215/227.md +0 -86
  18. package/docs/09-compatibility.md +0 -227
  19. package/docs/10-release.md +0 -1067
  20. package/docs/screenshots/01-home.png +0 -0
  21. package/docs/screenshots/02-notifications.png +0 -0
  22. package/docs/screenshots/03-sessions.png +0 -0
  23. package/docs/screenshots/04-chat.png +0 -0
  24. package/docs/screenshots/05-settings.png +0 -0
  25. package/docs/screenshots/06-new-session.png +0 -0
  26. package/docs/screenshots/pgy-appstore.jpg +0 -0
  27. package/docs/screenshots/pgy-mobile-app.jpg +0 -0
  28. package/docs/screenshots/pgy-pc-client.jpg +0 -0
  29. package/lib/account-usage.js +0 -145
  30. package/lib/app-alignment.js +0 -112
  31. package/lib/app-carrier-store.js +0 -1972
  32. package/lib/app-carrier.js +0 -609
  33. package/lib/client.js +0 -1174
  34. package/lib/desktop-form.js +0 -738
  35. package/lib/endpoint-registry.js +0 -167
  36. package/lib/git-read-bundled-provider.js +0 -450
  37. package/lib/git-read-service.js +0 -601
  38. package/lib/index.js +0 -9622
  39. package/lib/npm-update-source.js +0 -226
  40. package/lib/plugin-content-digest.js +0 -80
  41. package/lib/plugin-self-update.js +0 -997
  42. package/lib/plugin-update-controller.js +0 -274
  43. package/lib/plugin-update-log.js +0 -164
  44. package/lib/plugin-update-transaction.js +0 -322
  45. package/lib/plugin-update.js +0 -309
  46. package/lib/runtime-dependency-snapshot.js +0 -345
  47. package/lib/session-title-cache.js +0 -123
  48. package/lib/session-title-refresh.js +0 -261
  49. package/lib/tool-process.js +0 -20
  50. package/lib/update-fetch.js +0 -24
  51. package/lib/update-lock-arbiter.js +0 -170
  52. package/lib/update-supervisor.js +0 -346
  53. package/node_modules/ansi-regex/index.d.ts +0 -37
  54. package/node_modules/ansi-regex/index.js +0 -10
  55. package/node_modules/ansi-regex/license +0 -9
  56. package/node_modules/ansi-regex/package.json +0 -55
  57. package/node_modules/ansi-regex/readme.md +0 -78
  58. package/node_modules/ansi-styles/index.d.ts +0 -345
  59. package/node_modules/ansi-styles/index.js +0 -163
  60. package/node_modules/ansi-styles/license +0 -9
  61. package/node_modules/ansi-styles/package.json +0 -56
  62. package/node_modules/ansi-styles/readme.md +0 -152
  63. package/node_modules/camelcase/index.d.ts +0 -63
  64. package/node_modules/camelcase/index.js +0 -76
  65. package/node_modules/camelcase/license +0 -9
  66. package/node_modules/camelcase/package.json +0 -43
  67. package/node_modules/camelcase/readme.md +0 -99
  68. package/node_modules/cliui/CHANGELOG.md +0 -76
  69. package/node_modules/cliui/LICENSE.txt +0 -14
  70. package/node_modules/cliui/README.md +0 -115
  71. package/node_modules/cliui/index.js +0 -354
  72. package/node_modules/cliui/package.json +0 -65
  73. package/node_modules/color-convert/CHANGELOG.md +0 -54
  74. package/node_modules/color-convert/LICENSE +0 -21
  75. package/node_modules/color-convert/README.md +0 -68
  76. package/node_modules/color-convert/conversions.js +0 -839
  77. package/node_modules/color-convert/index.js +0 -81
  78. package/node_modules/color-convert/package.json +0 -48
  79. package/node_modules/color-convert/route.js +0 -97
  80. package/node_modules/color-name/LICENSE +0 -8
  81. package/node_modules/color-name/README.md +0 -11
  82. package/node_modules/color-name/index.js +0 -152
  83. package/node_modules/color-name/package.json +0 -28
  84. package/node_modules/decamelize/index.js +0 -13
  85. package/node_modules/decamelize/license +0 -21
  86. package/node_modules/decamelize/package.json +0 -38
  87. package/node_modules/decamelize/readme.md +0 -48
  88. package/node_modules/dijkstrajs/.travis.yml +0 -4
  89. package/node_modules/dijkstrajs/CONTRIBUTING.md +0 -8
  90. package/node_modules/dijkstrajs/LICENSE.md +0 -19
  91. package/node_modules/dijkstrajs/README.md +0 -18
  92. package/node_modules/dijkstrajs/dijkstra.js +0 -165
  93. package/node_modules/dijkstrajs/package.json +0 -60
  94. package/node_modules/dijkstrajs/test/dijkstra.test.js +0 -96
  95. package/node_modules/emoji-regex/LICENSE-MIT.txt +0 -20
  96. package/node_modules/emoji-regex/README.md +0 -73
  97. package/node_modules/emoji-regex/es2015/index.js +0 -6
  98. package/node_modules/emoji-regex/es2015/text.js +0 -6
  99. package/node_modules/emoji-regex/index.d.ts +0 -23
  100. package/node_modules/emoji-regex/index.js +0 -6
  101. package/node_modules/emoji-regex/package.json +0 -50
  102. package/node_modules/emoji-regex/text.js +0 -6
  103. package/node_modules/find-up/index.d.ts +0 -137
  104. package/node_modules/find-up/index.js +0 -89
  105. package/node_modules/find-up/license +0 -9
  106. package/node_modules/find-up/package.json +0 -53
  107. package/node_modules/find-up/readme.md +0 -156
  108. package/node_modules/get-caller-file/LICENSE.md +0 -6
  109. package/node_modules/get-caller-file/README.md +0 -41
  110. package/node_modules/get-caller-file/index.d.ts +0 -2
  111. package/node_modules/get-caller-file/index.js +0 -22
  112. package/node_modules/get-caller-file/index.js.map +0 -1
  113. package/node_modules/get-caller-file/package.json +0 -42
  114. package/node_modules/is-fullwidth-code-point/index.d.ts +0 -17
  115. package/node_modules/is-fullwidth-code-point/index.js +0 -50
  116. package/node_modules/is-fullwidth-code-point/license +0 -9
  117. package/node_modules/is-fullwidth-code-point/package.json +0 -42
  118. package/node_modules/is-fullwidth-code-point/readme.md +0 -39
  119. package/node_modules/locate-path/index.d.ts +0 -83
  120. package/node_modules/locate-path/index.js +0 -65
  121. package/node_modules/locate-path/license +0 -9
  122. package/node_modules/locate-path/package.json +0 -45
  123. package/node_modules/locate-path/readme.md +0 -122
  124. package/node_modules/p-limit/index.d.ts +0 -38
  125. package/node_modules/p-limit/index.js +0 -57
  126. package/node_modules/p-limit/license +0 -9
  127. package/node_modules/p-limit/package.json +0 -52
  128. package/node_modules/p-limit/readme.md +0 -101
  129. package/node_modules/p-locate/index.d.ts +0 -64
  130. package/node_modules/p-locate/index.js +0 -52
  131. package/node_modules/p-locate/license +0 -9
  132. package/node_modules/p-locate/package.json +0 -53
  133. package/node_modules/p-locate/readme.md +0 -90
  134. package/node_modules/p-try/index.d.ts +0 -39
  135. package/node_modules/p-try/index.js +0 -9
  136. package/node_modules/p-try/license +0 -9
  137. package/node_modules/p-try/package.json +0 -42
  138. package/node_modules/p-try/readme.md +0 -58
  139. package/node_modules/path-exists/index.d.ts +0 -28
  140. package/node_modules/path-exists/index.js +0 -23
  141. package/node_modules/path-exists/license +0 -9
  142. package/node_modules/path-exists/package.json +0 -39
  143. package/node_modules/path-exists/readme.md +0 -52
  144. package/node_modules/pngjs/.eslintignore +0 -2
  145. package/node_modules/pngjs/.eslintrc.json +0 -19
  146. package/node_modules/pngjs/.prettierignore +0 -3
  147. package/node_modules/pngjs/LICENSE +0 -20
  148. package/node_modules/pngjs/README.md +0 -429
  149. package/node_modules/pngjs/browser.js +0 -16096
  150. package/node_modules/pngjs/coverage/lcov-report/base.css +0 -354
  151. package/node_modules/pngjs/coverage/lcov-report/bitmapper.js.html +0 -881
  152. package/node_modules/pngjs/coverage/lcov-report/bitpacker.js.html +0 -554
  153. package/node_modules/pngjs/coverage/lcov-report/block-navigation.js +0 -77
  154. package/node_modules/pngjs/coverage/lcov-report/chunkstream.js.html +0 -647
  155. package/node_modules/pngjs/coverage/lcov-report/constants.js.html +0 -176
  156. package/node_modules/pngjs/coverage/lcov-report/crc.js.html +0 -200
  157. package/node_modules/pngjs/coverage/lcov-report/favicon.png +0 -0
  158. package/node_modules/pngjs/coverage/lcov-report/filter-pack.js.html +0 -593
  159. package/node_modules/pngjs/coverage/lcov-report/filter-parse-async.js.html +0 -152
  160. package/node_modules/pngjs/coverage/lcov-report/filter-parse-sync.js.html +0 -143
  161. package/node_modules/pngjs/coverage/lcov-report/filter-parse.js.html +0 -611
  162. package/node_modules/pngjs/coverage/lcov-report/format-normaliser.js.html +0 -359
  163. package/node_modules/pngjs/coverage/lcov-report/index.html +0 -426
  164. package/node_modules/pngjs/coverage/lcov-report/interlace.js.html +0 -365
  165. package/node_modules/pngjs/coverage/lcov-report/packer-async.js.html +0 -230
  166. package/node_modules/pngjs/coverage/lcov-report/packer-sync.js.html +0 -248
  167. package/node_modules/pngjs/coverage/lcov-report/packer.js.html +0 -467
  168. package/node_modules/pngjs/coverage/lcov-report/paeth-predictor.js.html +0 -128
  169. package/node_modules/pngjs/coverage/lcov-report/parser-async.js.html +0 -575
  170. package/node_modules/pngjs/coverage/lcov-report/parser-sync.js.html +0 -404
  171. package/node_modules/pngjs/coverage/lcov-report/parser.js.html +0 -950
  172. package/node_modules/pngjs/coverage/lcov-report/png-sync.js.html +0 -116
  173. package/node_modules/pngjs/coverage/lcov-report/png.js.html +0 -662
  174. package/node_modules/pngjs/coverage/lcov-report/prettify.css +0 -101
  175. package/node_modules/pngjs/coverage/lcov-report/prettify.js +0 -1007
  176. package/node_modules/pngjs/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  177. package/node_modules/pngjs/coverage/lcov-report/sorter.js +0 -169
  178. package/node_modules/pngjs/coverage/lcov-report/sync-inflate.js.html +0 -584
  179. package/node_modules/pngjs/coverage/lcov-report/sync-reader.js.html +0 -215
  180. package/node_modules/pngjs/coverage/lcov.info +0 -2177
  181. package/node_modules/pngjs/lib/bitmapper.js +0 -267
  182. package/node_modules/pngjs/lib/bitpacker.js +0 -158
  183. package/node_modules/pngjs/lib/chunkstream.js +0 -189
  184. package/node_modules/pngjs/lib/constants.js +0 -32
  185. package/node_modules/pngjs/lib/crc.js +0 -40
  186. package/node_modules/pngjs/lib/filter-pack.js +0 -171
  187. package/node_modules/pngjs/lib/filter-parse-async.js +0 -24
  188. package/node_modules/pngjs/lib/filter-parse-sync.js +0 -21
  189. package/node_modules/pngjs/lib/filter-parse.js +0 -177
  190. package/node_modules/pngjs/lib/format-normaliser.js +0 -93
  191. package/node_modules/pngjs/lib/interlace.js +0 -95
  192. package/node_modules/pngjs/lib/packer-async.js +0 -50
  193. package/node_modules/pngjs/lib/packer-sync.js +0 -56
  194. package/node_modules/pngjs/lib/packer.js +0 -129
  195. package/node_modules/pngjs/lib/paeth-predictor.js +0 -16
  196. package/node_modules/pngjs/lib/parser-async.js +0 -165
  197. package/node_modules/pngjs/lib/parser-sync.js +0 -108
  198. package/node_modules/pngjs/lib/parser.js +0 -290
  199. package/node_modules/pngjs/lib/png-sync.js +0 -12
  200. package/node_modules/pngjs/lib/png.js +0 -194
  201. package/node_modules/pngjs/lib/sync-inflate.js +0 -168
  202. package/node_modules/pngjs/lib/sync-reader.js +0 -45
  203. package/node_modules/pngjs/package.json +0 -73
  204. package/node_modules/qrcode/README.md +0 -770
  205. package/node_modules/qrcode/bin/qrcode +0 -159
  206. package/node_modules/qrcode/helper/to-sjis-browser.js +0 -2
  207. package/node_modules/qrcode/helper/to-sjis.js +0 -105
  208. package/node_modules/qrcode/lib/browser.js +0 -76
  209. package/node_modules/qrcode/lib/can-promise.js +0 -7
  210. package/node_modules/qrcode/lib/core/alignment-pattern.js +0 -83
  211. package/node_modules/qrcode/lib/core/alphanumeric-data.js +0 -59
  212. package/node_modules/qrcode/lib/core/bit-buffer.js +0 -37
  213. package/node_modules/qrcode/lib/core/bit-matrix.js +0 -65
  214. package/node_modules/qrcode/lib/core/byte-data.js +0 -30
  215. package/node_modules/qrcode/lib/core/error-correction-code.js +0 -135
  216. package/node_modules/qrcode/lib/core/error-correction-level.js +0 -50
  217. package/node_modules/qrcode/lib/core/finder-pattern.js +0 -22
  218. package/node_modules/qrcode/lib/core/format-info.js +0 -29
  219. package/node_modules/qrcode/lib/core/galois-field.js +0 -69
  220. package/node_modules/qrcode/lib/core/kanji-data.js +0 -54
  221. package/node_modules/qrcode/lib/core/mask-pattern.js +0 -234
  222. package/node_modules/qrcode/lib/core/mode.js +0 -167
  223. package/node_modules/qrcode/lib/core/numeric-data.js +0 -43
  224. package/node_modules/qrcode/lib/core/polynomial.js +0 -62
  225. package/node_modules/qrcode/lib/core/qrcode.js +0 -495
  226. package/node_modules/qrcode/lib/core/reed-solomon-encoder.js +0 -56
  227. package/node_modules/qrcode/lib/core/regex.js +0 -31
  228. package/node_modules/qrcode/lib/core/segments.js +0 -330
  229. package/node_modules/qrcode/lib/core/utils.js +0 -63
  230. package/node_modules/qrcode/lib/core/version-check.js +0 -9
  231. package/node_modules/qrcode/lib/core/version.js +0 -163
  232. package/node_modules/qrcode/lib/index.js +0 -12
  233. package/node_modules/qrcode/lib/renderer/canvas.js +0 -63
  234. package/node_modules/qrcode/lib/renderer/png.js +0 -78
  235. package/node_modules/qrcode/lib/renderer/svg-tag.js +0 -81
  236. package/node_modules/qrcode/lib/renderer/svg.js +0 -19
  237. package/node_modules/qrcode/lib/renderer/terminal/terminal-small.js +0 -85
  238. package/node_modules/qrcode/lib/renderer/terminal/terminal.js +0 -49
  239. package/node_modules/qrcode/lib/renderer/terminal.js +0 -9
  240. package/node_modules/qrcode/lib/renderer/utf8.js +0 -71
  241. package/node_modules/qrcode/lib/renderer/utils.js +0 -99
  242. package/node_modules/qrcode/lib/server.js +0 -138
  243. package/node_modules/qrcode/license +0 -10
  244. package/node_modules/qrcode/package.json +0 -77
  245. package/node_modules/require-directory/.jshintrc +0 -67
  246. package/node_modules/require-directory/.npmignore +0 -1
  247. package/node_modules/require-directory/.travis.yml +0 -3
  248. package/node_modules/require-directory/LICENSE +0 -22
  249. package/node_modules/require-directory/README.markdown +0 -184
  250. package/node_modules/require-directory/index.js +0 -86
  251. package/node_modules/require-directory/package.json +0 -40
  252. package/node_modules/require-main-filename/CHANGELOG.md +0 -26
  253. package/node_modules/require-main-filename/LICENSE.txt +0 -14
  254. package/node_modules/require-main-filename/README.md +0 -26
  255. package/node_modules/require-main-filename/index.js +0 -18
  256. package/node_modules/require-main-filename/package.json +0 -35
  257. package/node_modules/set-blocking/CHANGELOG.md +0 -26
  258. package/node_modules/set-blocking/LICENSE.txt +0 -14
  259. package/node_modules/set-blocking/README.md +0 -31
  260. package/node_modules/set-blocking/index.js +0 -7
  261. package/node_modules/set-blocking/package.json +0 -42
  262. package/node_modules/string-width/index.d.ts +0 -29
  263. package/node_modules/string-width/index.js +0 -47
  264. package/node_modules/string-width/license +0 -9
  265. package/node_modules/string-width/package.json +0 -56
  266. package/node_modules/string-width/readme.md +0 -50
  267. package/node_modules/strip-ansi/index.d.ts +0 -17
  268. package/node_modules/strip-ansi/index.js +0 -4
  269. package/node_modules/strip-ansi/license +0 -9
  270. package/node_modules/strip-ansi/package.json +0 -54
  271. package/node_modules/strip-ansi/readme.md +0 -46
  272. package/node_modules/which-module/LICENSE +0 -13
  273. package/node_modules/which-module/README.md +0 -58
  274. package/node_modules/which-module/index.js +0 -9
  275. package/node_modules/which-module/package.json +0 -41
  276. package/node_modules/wrap-ansi/index.js +0 -186
  277. package/node_modules/wrap-ansi/license +0 -9
  278. package/node_modules/wrap-ansi/package.json +0 -61
  279. package/node_modules/wrap-ansi/readme.md +0 -97
  280. package/node_modules/y18n/CHANGELOG.md +0 -35
  281. package/node_modules/y18n/LICENSE +0 -13
  282. package/node_modules/y18n/README.md +0 -109
  283. package/node_modules/y18n/index.js +0 -188
  284. package/node_modules/y18n/package.json +0 -39
  285. package/node_modules/yargs/CHANGELOG.md +0 -420
  286. package/node_modules/yargs/LICENSE +0 -21
  287. package/node_modules/yargs/README.md +0 -140
  288. package/node_modules/yargs/build/lib/apply-extends.d.ts +0 -2
  289. package/node_modules/yargs/build/lib/apply-extends.js +0 -65
  290. package/node_modules/yargs/build/lib/argsert.d.ts +0 -2
  291. package/node_modules/yargs/build/lib/argsert.js +0 -65
  292. package/node_modules/yargs/build/lib/command.d.ts +0 -64
  293. package/node_modules/yargs/build/lib/command.js +0 -416
  294. package/node_modules/yargs/build/lib/common-types.d.ts +0 -36
  295. package/node_modules/yargs/build/lib/common-types.js +0 -25
  296. package/node_modules/yargs/build/lib/completion-templates.d.ts +0 -2
  297. package/node_modules/yargs/build/lib/completion-templates.js +0 -50
  298. package/node_modules/yargs/build/lib/completion.d.ts +0 -21
  299. package/node_modules/yargs/build/lib/completion.js +0 -135
  300. package/node_modules/yargs/build/lib/is-promise.d.ts +0 -1
  301. package/node_modules/yargs/build/lib/is-promise.js +0 -9
  302. package/node_modules/yargs/build/lib/levenshtein.d.ts +0 -1
  303. package/node_modules/yargs/build/lib/levenshtein.js +0 -58
  304. package/node_modules/yargs/build/lib/middleware.d.ts +0 -10
  305. package/node_modules/yargs/build/lib/middleware.js +0 -57
  306. package/node_modules/yargs/build/lib/obj-filter.d.ts +0 -1
  307. package/node_modules/yargs/build/lib/obj-filter.js +0 -14
  308. package/node_modules/yargs/build/lib/parse-command.d.ts +0 -11
  309. package/node_modules/yargs/build/lib/parse-command.js +0 -36
  310. package/node_modules/yargs/build/lib/process-argv.d.ts +0 -2
  311. package/node_modules/yargs/build/lib/process-argv.js +0 -31
  312. package/node_modules/yargs/build/lib/usage.d.ts +0 -49
  313. package/node_modules/yargs/build/lib/usage.js +0 -540
  314. package/node_modules/yargs/build/lib/validation.d.ts +0 -34
  315. package/node_modules/yargs/build/lib/validation.js +0 -330
  316. package/node_modules/yargs/build/lib/yargs.d.ts +0 -274
  317. package/node_modules/yargs/build/lib/yargs.js +0 -1190
  318. package/node_modules/yargs/build/lib/yerror.d.ts +0 -4
  319. package/node_modules/yargs/build/lib/yerror.js +0 -11
  320. package/node_modules/yargs/index.js +0 -40
  321. package/node_modules/yargs/locales/be.json +0 -46
  322. package/node_modules/yargs/locales/de.json +0 -46
  323. package/node_modules/yargs/locales/en.json +0 -51
  324. package/node_modules/yargs/locales/es.json +0 -46
  325. package/node_modules/yargs/locales/fi.json +0 -49
  326. package/node_modules/yargs/locales/fr.json +0 -53
  327. package/node_modules/yargs/locales/hi.json +0 -49
  328. package/node_modules/yargs/locales/hu.json +0 -46
  329. package/node_modules/yargs/locales/id.json +0 -50
  330. package/node_modules/yargs/locales/it.json +0 -46
  331. package/node_modules/yargs/locales/ja.json +0 -51
  332. package/node_modules/yargs/locales/ko.json +0 -49
  333. package/node_modules/yargs/locales/nb.json +0 -44
  334. package/node_modules/yargs/locales/nl.json +0 -49
  335. package/node_modules/yargs/locales/nn.json +0 -44
  336. package/node_modules/yargs/locales/pirate.json +0 -13
  337. package/node_modules/yargs/locales/pl.json +0 -49
  338. package/node_modules/yargs/locales/pt.json +0 -45
  339. package/node_modules/yargs/locales/pt_BR.json +0 -48
  340. package/node_modules/yargs/locales/ru.json +0 -46
  341. package/node_modules/yargs/locales/th.json +0 -46
  342. package/node_modules/yargs/locales/tr.json +0 -48
  343. package/node_modules/yargs/locales/zh_CN.json +0 -48
  344. package/node_modules/yargs/locales/zh_TW.json +0 -47
  345. package/node_modules/yargs/package.json +0 -92
  346. package/node_modules/yargs/yargs.js +0 -14
  347. package/node_modules/yargs-parser/CHANGELOG.md +0 -601
  348. package/node_modules/yargs-parser/LICENSE.txt +0 -14
  349. package/node_modules/yargs-parser/README.md +0 -449
  350. package/node_modules/yargs-parser/index.js +0 -1032
  351. package/node_modules/yargs-parser/lib/tokenize-arg-string.js +0 -40
  352. package/node_modules/yargs-parser/package.json +0 -46
@@ -1,429 +0,0 @@
1
- [![Build Status](https://travis-ci.com/lukeapage/pngjs.svg?branch=master)](https://travis-ci.com/lukeapage/pngjs) [![Build status](https://ci.appveyor.com/api/projects/status/qo5x8ayutr028108/branch/master?svg=true)](https://ci.appveyor.com/project/lukeapage/pngjs/branch/master) [![codecov](https://codecov.io/gh/lukeapage/pngjs/branch/master/graph/badge.svg)](https://codecov.io/gh/lukeapage/pngjs) [![npm version](https://badge.fury.io/js/pngjs.svg)](http://badge.fury.io/js/pngjs)
2
-
3
- # pngjs
4
-
5
- Simple PNG encoder/decoder for Node.js with no dependencies.
6
-
7
- Based on the original [pngjs](https://github.com/niegowski/node-pngjs) with the follow enhancements.
8
-
9
- - Support for reading 1,2,4 & 16 bit files
10
- - Support for reading interlace files
11
- - Support for reading `tTRNS` transparent colours
12
- - Support for writing colortype 0 (grayscale), colortype 2 (RGB), colortype 4 (grayscale alpha) and colortype 6 (RGBA)
13
- - Sync interface as well as async
14
- - API compatible with pngjs and node-pngjs
15
-
16
- Known lack of support for:
17
-
18
- - Extended PNG e.g. Animation
19
- - Writing in colortype 3 (indexed color)
20
-
21
- # Table of Contents
22
-
23
- - [Requirements](#requirements)
24
- - [Comparison Table](#comparison-table)
25
- - [Tests](#tests)
26
- - [Installation](#installation)
27
- - [Browser](#browser)
28
- - [Example](#example)
29
- - [Async API](#async-api)
30
- - [Sync API](#sync-api)
31
- - [Changelog](#changelog)
32
-
33
- # Requirements
34
-
35
- - Node.js v4 (use older v2.3.0 for 0.10/0.12/iojs support)
36
-
37
- # Comparison Table
38
-
39
- | Name | Forked From | Sync | Async | 16 Bit | 1/2/4 Bit | Interlace | Gamma | Encodes | Tested |
40
- | ------------- | ----------- | ---- | ----- | ------ | --------- | --------- | ------ | ------- | ------ |
41
- | pngjs | | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
42
- | node-png | pngjs | No | Yes | No | No | No | Hidden | Yes | Manual |
43
- | png-coder | pngjs | No | Yes | Yes | No | No | Hidden | Yes | Manual |
44
- | pngparse | | No | Yes | No | Yes | No | No | No | Yes |
45
- | pngparse-sync | pngparse | Yes | No | No | Yes | No | No | No | Yes |
46
- | png-async | | No | Yes | No | No | No | No | Yes | Yes |
47
- | png-js | | No | Yes | No | No | No | No | No | No |
48
-
49
- Native C++ node decoders:
50
-
51
- - png
52
- - png-sync (sync version of above)
53
- - pixel-png
54
- - png-img
55
-
56
- # Tests
57
-
58
- Tested using [PNG Suite](http://www.schaik.com/pngsuite/). We read every file into pngjs, output it in standard 8bit colour, synchronously and asynchronously, then compare the original with the newly saved images.
59
-
60
- To run the tests, fetch the repo (tests are not distributed via npm) and install with `npm i`, run `npm test`.
61
-
62
- The only thing not converted is gamma correction - this is because multiple vendors will do gamma correction differently, so the tests will have different results on different browsers.
63
-
64
- In addition we use a tolerance of 3 for 16 bit images in PhantomJS because PhantomJS seems to have non-compliant rules for downscaling 16 bit images.
65
-
66
- # Installation
67
-
68
- ```
69
- $ npm install pngjs --save
70
- ```
71
-
72
- # Browser
73
-
74
- The package has been build with a [Browserify](browserify.org) version (`npm run browserify`) and you can use the browser version by including in your code:
75
-
76
- ```
77
- import { PNG } from 'pngjs/browser';
78
- ```
79
-
80
- # Example
81
-
82
- ```js
83
- var fs = require("fs"),
84
- PNG = require("pngjs").PNG;
85
-
86
- fs.createReadStream("in.png")
87
- .pipe(
88
- new PNG({
89
- filterType: 4,
90
- })
91
- )
92
- .on("parsed", function () {
93
- for (var y = 0; y < this.height; y++) {
94
- for (var x = 0; x < this.width; x++) {
95
- var idx = (this.width * y + x) << 2;
96
-
97
- // invert color
98
- this.data[idx] = 255 - this.data[idx];
99
- this.data[idx + 1] = 255 - this.data[idx + 1];
100
- this.data[idx + 2] = 255 - this.data[idx + 2];
101
-
102
- // and reduce opacity
103
- this.data[idx + 3] = this.data[idx + 3] >> 1;
104
- }
105
- }
106
-
107
- this.pack().pipe(fs.createWriteStream("out.png"));
108
- });
109
- ```
110
-
111
- For more examples see `examples` folder.
112
-
113
- # Async API
114
-
115
- As input any color type is accepted (grayscale, rgb, palette, grayscale with alpha, rgb with alpha) but 8 bit per sample (channel) is the only supported bit depth. Interlaced mode is not supported.
116
-
117
- ## Class: PNG
118
-
119
- `PNG` is readable and writable `Stream`.
120
-
121
- ### Options
122
-
123
- - `width` - use this with `height` if you want to create png from scratch
124
- - `height` - as above
125
- - `checkCRC` - whether parser should be strict about checksums in source stream (default: `true`)
126
- - `deflateChunkSize` - chunk size used for deflating data chunks, this should be power of 2 and must not be less than 256 and more than 32\*1024 (default: 32 kB)
127
- - `deflateLevel` - compression level for deflate (default: 9)
128
- - `deflateStrategy` - compression strategy for deflate (default: 3)
129
- - `deflateFactory` - deflate stream factory (default: `zlib.createDeflate`)
130
- - `filterType` - png filtering method for scanlines (default: -1 => auto, accepts array of numbers 0-4)
131
- - `colorType` - the output colorType - see constants. 0 = grayscale, no alpha, 2 = color, no alpha, 4 = grayscale & alpha, 6 = color & alpha. Default currently 6, but in the future may calculate best mode.
132
- - `inputColorType` - the input colorType - see constants. Default is 6 (RGBA)
133
- - `bitDepth` - the bitDepth of the output, 8 or 16 bits. Input data is expected to have this bit depth.
134
- 16 bit data is expected in the system endianness (Default: 8)
135
- - `inputHasAlpha` - whether the input bitmap has 4 bytes per pixel (rgb and alpha) or 3 (rgb - no alpha).
136
- - `bgColor` - an object containing red, green, and blue values between 0 and 255
137
- that is used when packing a PNG if alpha is not to be included (default: 255,255,255)
138
-
139
- ### Event "metadata"
140
-
141
- `function(metadata) { }`
142
- Image's header has been parsed, metadata contains this information:
143
-
144
- - `width` image size in pixels
145
- - `height` image size in pixels
146
- - `palette` image is paletted
147
- - `color` image is not grayscale
148
- - `alpha` image contains alpha channel
149
- - `interlace` image is interlaced
150
-
151
- ### Event: "parsed"
152
-
153
- `function(data) { }`
154
- Input image has been completely parsed, `data` is complete and ready for modification.
155
-
156
- ### Event: "error"
157
-
158
- `function(error) { }`
159
-
160
- ### png.parse(data, [callback])
161
-
162
- Parses PNG file data. Can be `String` or `Buffer`. Alternatively you can stream data to instance of PNG.
163
-
164
- Optional `callback` is once called on `error` or `parsed`. The callback gets
165
- two arguments `(err, data)`.
166
-
167
- Returns `this` for method chaining.
168
-
169
- #### Example
170
-
171
- ```js
172
- new PNG({ filterType: 4 }).parse(imageData, function (error, data) {
173
- console.log(error, data);
174
- });
175
- ```
176
-
177
- ### png.pack()
178
-
179
- Starts converting data to PNG file Stream.
180
-
181
- Returns `this` for method chaining.
182
-
183
- ### png.bitblt(dst, sx, sy, w, h, dx, dy)
184
-
185
- Helper for image manipulation, copies a rectangle of pixels from current (i.e. the source) image (`sx`, `sy`, `w`, `h`) to `dst` image (at `dx`, `dy`).
186
-
187
- Returns `this` for method chaining.
188
-
189
- For example, the following code copies the top-left 100x50 px of `in.png` into dst and writes it to `out.png`:
190
-
191
- ```js
192
- var dst = new PNG({ width: 100, height: 50 });
193
- fs.createReadStream("in.png")
194
- .pipe(new PNG())
195
- .on("parsed", function () {
196
- this.bitblt(dst, 0, 0, 100, 50, 0, 0);
197
- dst.pack().pipe(fs.createWriteStream("out.png"));
198
- });
199
- ```
200
-
201
- ### Property: adjustGamma()
202
-
203
- Helper that takes data and adjusts it to be gamma corrected. Note that it is not 100% reliable with transparent colours because that requires knowing the background colour the bitmap is rendered on to.
204
-
205
- In tests against PNG suite it compared 100% with chrome on all 8 bit and below images. On IE there were some differences.
206
-
207
- The following example reads a file, adjusts the gamma (which sets the gamma to 0) and writes it out again, effectively removing any gamma correction from the image.
208
-
209
- ```js
210
- fs.createReadStream("in.png")
211
- .pipe(new PNG())
212
- .on("parsed", function () {
213
- this.adjustGamma();
214
- this.pack().pipe(fs.createWriteStream("out.png"));
215
- });
216
- ```
217
-
218
- ### Property: width
219
-
220
- Width of image in pixels
221
-
222
- ### Property: height
223
-
224
- Height of image in pixels
225
-
226
- ### Property: data
227
-
228
- Buffer of image pixel data. Every pixel consists 4 bytes: R, G, B, A (opacity).
229
-
230
- ### Property: gamma
231
-
232
- Gamma of image (0 if not specified)
233
-
234
- ## Packing a PNG and removing alpha (RGBA to RGB)
235
-
236
- When removing the alpha channel from an image, there needs to be a background color to correctly
237
- convert each pixel's transparency to the appropriate RGB value. By default, pngjs will flatten
238
- the image against a white background. You can override this in the options:
239
-
240
- ```js
241
- var fs = require("fs"),
242
- PNG = require("pngjs").PNG;
243
-
244
- fs.createReadStream("in.png")
245
- .pipe(
246
- new PNG({
247
- colorType: 2,
248
- bgColor: {
249
- red: 0,
250
- green: 255,
251
- blue: 0,
252
- },
253
- })
254
- )
255
- .on("parsed", function () {
256
- this.pack().pipe(fs.createWriteStream("out.png"));
257
- });
258
- ```
259
-
260
- # Sync API
261
-
262
- ## PNG.sync
263
-
264
- ### PNG.sync.read(buffer)
265
-
266
- Take a buffer and returns a PNG image. The properties on the image include the meta data and `data` as per the async API above.
267
-
268
- ```
269
- var data = fs.readFileSync('in.png');
270
- var png = PNG.sync.read(data);
271
- ```
272
-
273
- ### PNG.sync.write(png)
274
-
275
- Take a PNG image and returns a buffer. The properties on the image include the meta data and `data` as per the async API above.
276
-
277
- ```
278
- var data = fs.readFileSync('in.png');
279
- var png = PNG.sync.read(data);
280
- var options = { colorType: 6 };
281
- var buffer = PNG.sync.write(png, options);
282
- fs.writeFileSync('out.png', buffer);
283
- ```
284
-
285
- ### PNG.adjustGamma(src)
286
-
287
- Adjusts the gamma of a sync image. See the async adjustGamma.
288
-
289
- ```
290
- var data = fs.readFileSync('in.png');
291
- var png = PNG.sync.read(data);
292
- PNG.adjustGamma(png);
293
- ```
294
-
295
- # Changelog
296
-
297
- ### 5.0.0 - 15/04/2020
298
-
299
- - Drop support for Node 8
300
- - Browserified bundle may now contain ES20(15-20) code if the supported node version supports it. Please run the browserified version through babel if you need to support older browsers.
301
-
302
- ### 4.0.1 - 15/04/2020
303
-
304
- - Fix to possible null reference in nextTick of async method
305
-
306
- ### 4.0.0 - 09/04/2020
307
-
308
- - Fix issue in newer nodes with using Buffer
309
- - Fix async issue with some png files
310
- - Drop support for Node 4 & 6
311
-
312
- ### 3.4.0 - 09/03/2019
313
-
314
- - Include whether the png has alpha in the meta data
315
- - emit an error if the image is truncated instead of hanging
316
- - Add a browserified version
317
- - speed up some mapping functions
318
-
319
- ### 3.3.3 - 19/04/2018
320
-
321
- - Real fix for node 9
322
-
323
- ### 3.3.2 - 16/02/2018
324
-
325
- - Fix for node 9
326
-
327
- ### 3.3.1 - 15/11/2017
328
-
329
- - Bugfixes and removal of es6
330
-
331
- ### 3.3.0
332
-
333
- - Add writing 16 bit channels and support for grayscale input
334
-
335
- ### 3.2.0 - 30/04/2017
336
-
337
- - Support for encoding 8-bit grayscale images
338
-
339
- ### 3.1.0 - 30/04/2017
340
-
341
- - Support for pngs with zlib chunks that are malformed after valid data
342
-
343
- ### 3.0.1 - 16/02/2017
344
-
345
- - Fix single pixel pngs
346
-
347
- ### 3.0.0 - 03/08/2016
348
-
349
- - Drop support for node below v4 and iojs. Pin to 2.3.0 to use with old, unsupported or patched node versions.
350
-
351
- ### 2.3.0 - 22/04/2016
352
-
353
- - Support for sync in node 0.10
354
-
355
- ### 2.2.0 - 04/12/2015
356
-
357
- - Add sync write api
358
- - Fix newfile example
359
- - Correct comparison table
360
-
361
- ### 2.1.0 - 28/10/2015
362
-
363
- - rename package to pngjs
364
- - added 'bgColor' option
365
-
366
- ### 2.0.0 - 08/10/2015
367
-
368
- - fixes to readme
369
- - _breaking change_ - bitblt on the png prototype now doesn't take a unused, unnecessary src first argument
370
-
371
- ### 1.2.0 - 13/09/2015
372
-
373
- - support passing colorType to write PNG's and writing bitmaps without alpha information
374
-
375
- ### 1.1.0 - 07/09/2015
376
-
377
- - support passing a deflate factory for controlled compression
378
-
379
- ### 1.0.2 - 22/08/2015
380
-
381
- - Expose all PNG creation info
382
-
383
- ### 1.0.1 - 21/08/2015
384
-
385
- - Fix non square interlaced files
386
-
387
- ### 1.0.0 - 08/08/2015
388
-
389
- - More tests
390
- - source linted
391
- - maintainability refactorings
392
- - async API - exceptions in reading now emit warnings
393
- - documentation improvement - sync api now documented, adjustGamma documented
394
- - breaking change - gamma chunk is now written. previously a read then write would destroy gamma information, now it is persisted.
395
-
396
- ### 0.0.3 - 03/08/2015
397
-
398
- - Error handling fixes
399
- - ignore files for smaller npm footprint
400
-
401
- ### 0.0.2 - 02/08/2015
402
-
403
- - Bugfixes to interlacing, support for transparent colours
404
-
405
- ### 0.0.1 - 02/08/2015
406
-
407
- - Initial release, see pngjs for older changelog.
408
-
409
- # License
410
-
411
- (The MIT License)
412
-
413
- Permission is hereby granted, free of charge, to any person obtaining a copy
414
- of this software and associated documentation files (the "Software"), to deal
415
- in the Software without restriction, including without limitation the rights
416
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
417
- copies of the Software, and to permit persons to whom the Software is
418
- furnished to do so, subject to the following conditions:
419
-
420
- The above copyright notice and this permission notice shall be included in
421
- all copies or substantial portions of the Software.
422
-
423
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
424
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
425
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
426
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
427
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
428
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
429
- THE SOFTWARE.