@litecanvas/plugin-migrate 0.4.1 → 0.6.0

package/README.md

@@ -2,11 +2,22 @@
 
 Sometimes upgrading litecanvas to a new version can be a lot of work. This plugin makes this easier, by restoring the Litecanvas APIs that were removed in newer versions, and additionally shows warnings in the browser console when removed and/or deprecated APIs are used.
 
+<!-- prettier-ignore -->
+> [!TIP]
+> **This plugin is automatically loaded on Litecanvas [playground](https://litecanvas.js.org/) to maintain compatibility and avoid breaking code written for older versions.**
+
 ## Install
 
-**NPM**: `npm i @litecanvas/plugin-migrate`
+### NPM
+
+```
+npm i @litecanvas/plugin-migrate
+```
+
+### CDN
 
-**CDN**: `https://unpkg.com/@litecanvas/plugin-migrate/dist/dist.js`
+- Unpkg: `https://unpkg.com/@litecanvas/plugin-migrate/dist/dist.js`
+- jsDelivr: `https://cdn.jsdelivr.net/npm/@litecanvas/plugin-migrate/dist/dist.js`
 
 ## Usage
 

package/dist/dist.js

@@ -1,3 +1,3 @@
-(()=>{var x=(s,c,h,m,n,r,b,f)=>s<n+b&&s+h>n&&c<r+f&&c+m>r;var _=(s,c,h,m,n,r)=>(m-s)*(m-s)+(n-c)*(n-c)<=(h+r)*(h+r);var At=2*Math.PI;var ge=Math.PI/2;var j={warnings:!0};function v(s,c={}){c=Object.assign({},j,c);let h=s.stat(1),m={def:u,seed:b,print:N,clear:I,setfps:S,setvar:R,textstyle:w,textmetrics:E,cliprect:M,clipcirc:T,blendmode:A,transform:k,getcolor:y,mousepos:P,resize:C,path:L,fill:Y,stroke:F,clip:X,paint:W,colrect:x,colcirc:_};if(h)throw'Plugin Migrate should be loaded before the "init" event';let n=s.stat(0);function r(t,e,a=""){c.warnings&&console.warn(`[litecanvas/migrate] ${t} is removed. `+(e?`Use ${e} instead. `:"")+a)}function b(t){return r("seed()","rseed()"),t&&s.rseed(t),s.stat(9)}let f="";function w(t){r("textstyle()","the 5th param of text()"),f=t}function N(t,e,a,i){r("print()","text()"),s.text(t,e,a,i)}function E(t,e){r("textmetrics()","ctx().measureText()");let a=s.ctx(),i=s.stat(10),l=s.stat(11);a.font=`${f||""} ${~~(e||i)}px ${l}`;let p=a.measureText(t);return p.height=p.actualBoundingBoxAscent+p.actualBoundingBoxDescent,p}function M(t,e,a,i){r("cliprect()","clip()");let l=s.ctx();l.beginPath(),l.rect(t,e,a,i),l.clip()}function T(t,e,a){r("clipcirc()","clip()");let i=s.ctx();i.beginPath(),i.arc(t,e,a,0,s.TWO_PI),i.clip()}function y(t){r("getcolor()","stat(5)");let e=stat(5);return e[~~t%e.length]}function A(t){r("blendmode()","ctx().globalCompositeOperation");let e=s.ctx();e.globalCompositeOperation=t}function I(t){r("clear()","cls()"),s.cls(t)}function k(t,e,a,i,l,p,B=!0){return r("transform()","ctx().setTransform() or ctx().transform()"),s.ctx()[B?"setTransform":"transform"](t,e,a,i,l,p)}function P(){return r("mousepos()","MX and MY"),[MX,MY]}function S(t){r("setfps()","framerate()"),s.framerate(t)}let o=s.def;function u(t,e){switch(t){case"W":case"WIDTH":o("W",e),o("WIDTH",e);break;case"H":case"HEIGHT":o("H",e),o("HEIGHT",e);break;case"T":case"ELAPSED":o("T",e),o("ELAPSED",e);break;case"CX":case"CENTERX":o("CX",e),o("CENTERX",e);break;case"CY":case"CENTERY":o("CY",e),o("CENTERY",e);break;case"MX":case"MOUSEX":o("MX",e),o("MOUSEX",e);break;case"MY":case"MOUSEY":o("MY",e),o("MOUSEY",e);break;default:o(t,e);break}}function R(t,e){r("setvar()","def()"),u(t,e)}s.listen("resized",g);function g(){u("CX",s.W/2),u("CY",s.H/2)}g(),u("CANVAS",s.canvas());function C(t,e){if(n.autoscale)throw"resize() don't works with autoscale enabled";r("resize()",null,"Avoid changing the canvas dimensions at runtime."),s.CANVAS.width=t,u("W",t),s.CANVAS.height=e,u("H",e),s.emit("resized",1)}for(let t of["W","H","T","CX","CY","MX","MY"])s[t]!=null&&u(t,s[t]);if(r("FPS","","but you can use our plugin to measure the fps: https://github.com/litecanvas/plugin-frame-rate-meter"),o("FPS",""),n.fps&&s.framerate(n.fps),n.background!=null){r('"background" option',"You must update your canvas CSS");let t=s.listen("before:draw",()=>{s.canvas().style.background=y(~~n.background),t()})}function L(t){return r("path()","`new Path2D()`","See https://developer.mozilla.org/en-US/docs/Web/API/Path2D"),new Path2D(t)}let z=s.fill;function Y(t,e){if(e instanceof Path2D){r("fill(color, path)");let a=s.stat(5),i=s.ctx();i.fillStyle=a[~~t%a.length],s.ctx().fill(e)}else z(t)}let O=s.stroke;function F(t,e){if(e instanceof Path2D){r("stroke(color, path)");let a=s.stat(5),i=s.ctx();i.strokeStyle=a[~~t%a.length],s.ctx().stroke(e)}else O(t)}let D=s.clip;function X(t){r("clip(path)","clip(callback)","E.g: `clip((ctx) => ctx.rect(0, 0, 200, 200))`"),t instanceof Path2D?s.ctx().clip(t):D(t)}n.antialias&&r('"antialias" option','"pixelart" option'),n.pixelart===!1&&r('"pixelart" option'),n.animate===!1&&r('"animate" option',"pause() in the of your draw()");let H=s.paint;function W(t,e,a,i){let l=a;return s.spr&&Array.isArray(a)&&(l=()=>{s.spr(0,0,a.join(`
-`))}),H(t,e,l,i)}let d=s.spr;return d&&d.length===3&&(m.spr=function(t,e,a,i,l){Number.isFinite(a)&&a>0?(r("spr() width and height","spr(x, y, pixels)"),d(t,e,l)):d(t,e,a)}),m}window.pluginMigrate=v;})();
+(()=>{var _=(r,u,p,m,n,f,b,x)=>r<n+b&&r+p>n&&u<f+x&&u+m>f;var y=(r,u,p,m,n,f)=>(m-r)*(m-r)+(n-u)*(n-u)<=(p+f)*(p+f);var Bt=2*Math.PI;var N=(r,u,p,m=Math.sin)=>r+(m(p)+1)/2*(u-r);var vr=Math.PI/2;var tt={warnings:!0};function v(r,u={}){if(r.stat(1))throw'Plugin Migrate should be loaded before the "init" event';u=Object.assign({},tt,u);let m={def:c,seed:f,print:T,clear:R,setfps:z,setvar:Y,textstyle:x,textmetrics:I,cliprect:k,clipcirc:F,blendmode:S,transform:C,getcolor:w,mousepos:L,resize:O,path:H,fill:B,stroke:D,clip:V,paint:$,colrect:(...t)=>(g("colrect()"),_(...t)),colcirc:(...t)=>(g("colrect()"),y(...t)),wave:(...t)=>(g("wave()"),N(...t))},n=r.stat(0);function f(t){return a("seed()","rseed()"),t&&r.rseed(t),r.stat(9)}let b="";function x(t){a("textstyle()","the 5th param of text()"),b=t}function T(t,e,s,i){a("print()","text()"),r.text(t,e,s,i)}function I(t,e){a("textmetrics()","ctx().measureText()");let s=r.ctx(),i=r.stat(10),l=r.stat(11);s.font=`${b||""} ${~~(e||i)}px ${l}`;let h=s.measureText(t);return h.height=h.actualBoundingBoxAscent+h.actualBoundingBoxDescent,h}function k(t,e,s,i){a("cliprect()","clip()");let l=r.ctx();l.beginPath(),l.rect(t,e,s,i),l.clip()}function F(t,e,s){a("clipcirc()","clip()");let i=r.ctx();i.beginPath(),i.arc(t,e,s,0,r.TWO_PI),i.clip()}function w(t){a("getcolor()","stat(5)");let e=stat(5);return e[~~t%e.length]}function S(t){a("blendmode()","ctx().globalCompositeOperation");let e=r.ctx();e.globalCompositeOperation=t}function R(t){a("clear()","cls()"),r.cls(t)}function C(t,e,s,i,l,h,j=!0){return a("transform()","ctx().setTransform() or ctx().transform()"),r.ctx()[j?"setTransform":"transform"](t,e,s,i,l,h)}function L(){return a("mousepos()","MX and MY"),[MX,MY]}function z(t){a("setfps()","framerate()"),r.framerate(t)}let o=r.def;function c(t,e){switch(t){case"W":case"WIDTH":o("W",e),o("WIDTH",e);break;case"H":case"HEIGHT":o("H",e),o("HEIGHT",e);break;case"T":case"ELAPSED":o("T",e),o("ELAPSED",e);break;case"CX":case"CENTERX":o("CX",e),o("CENTERX",e);break;case"CY":case"CENTERY":o("CY",e),o("CENTERY",e);break;case"MX":case"MOUSEX":o("MX",e),o("MOUSEX",e);break;case"MY":case"MOUSEY":o("MY",e),o("MOUSEY",e);break;default:o(t,e);break}}function Y(t,e){a("setvar()","def()"),c(t,e)}r.listen("resized",E);function E(){c("CX",r.W/2),c("CY",r.H/2)}E(),c("CANVAS",r.canvas());function O(t,e){if(n.autoscale)throw"resize() don't works with autoscale enabled";a("resize()",null,"Avoid changing the canvas dimensions at runtime."),r.CANVAS.width=t,c("W",t),r.CANVAS.height=e,c("H",e),r.emit("resized",1)}for(let t of["W","H","T","CX","CY","MX","MY"])r[t]!=null&&c(t,r[t]);if(a("FPS","","but you can use our plugin to measure the fps: https://github.com/litecanvas/plugin-frame-rate-meter"),o("FPS",""),n.fps&&r.framerate(n.fps),n.background!=null){a('"background" option',"You must update your canvas CSS");let t=r.listen("before:draw",()=>{r.canvas().style.background=w(~~n.background),t()})}function H(t){return a("path()","`new Path2D()`","See https://developer.mozilla.org/en-US/docs/Web/API/Path2D"),new Path2D(t)}let X=r.fill;function B(t,e){if(e instanceof Path2D){a("fill(color, path)");let s=r.stat(5),i=r.ctx();i.fillStyle=s[~~t%s.length],r.ctx().fill(e)}else X(t)}let W=r.stroke;function D(t,e){if(e instanceof Path2D){a("stroke(color, path)");let s=r.stat(5),i=r.ctx();i.strokeStyle=s[~~t%s.length],r.ctx().stroke(e)}else W(t)}let U=r.clip;function V(t){a("clip(path)","clip(callback)","E.g: `clip((ctx) => ctx.rect(0, 0, 200, 200))`"),t instanceof Path2D?r.ctx().clip(t):U(t)}n.antialias&&a('"antialias" option','"pixelart" option'),n.pixelart===!1&&a('"pixelart" option'),n.animate===!1&&a('"animate" option',"pause() in the of your draw()");let Z=r.paint;function $(t,e,s,i){let l=s;return r.spr&&Array.isArray(s)&&(l=()=>{r.spr(0,0,s.join(`
+`))}),Z(t,e,l,i)}let d=r.spr;d&&d.length===3&&(m.spr=function(t,e,s,i,l){Number.isFinite(s)&&s>0?(a("spr() width and height","spr(x, y, pixels)"),d(t,e,l)):d(t,e,s)});let M=r.unlisten;if(M){let t=r.listen;m.listen=(e,s)=>(t(e,s),()=>{A("listen() not returns a function anymore. Please use unlisten(event, callback) instead"),M(e,s)})}function A(t){u.warnings&&console.warn(`[litecanvas/migrate] ${t}.`)}function a(t,e,s=""){A(`${t} is removed. `+(e?`Please use ${e} instead. `:"")+s)}function g(t,e="function"){a(t,`This ${e} was moved to @litecanvas/utils package.`)}return m}window.pluginMigrate=v;})();
 /*! Migrate for litecanvas by Luiz Bills | MIT Licensed */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@litecanvas/plugin-migrate",
-  "version": "0.4.1",
+  "version": "0.6.0",
   "description": "Sometimes upgrading litecanvas to a new version can be a lot of work. This plugin makes this easier, by restoring the Litecanvas APIs that were removed in newer versions, and additionally shows warnings in the browser console when removed and/or deprecated APIs are used.",
   "author": "Luiz Bills <luizbills@pm.me>",
   "license": "MIT",
@@ -14,8 +14,12 @@
   },
   "type": "module",
   "main": "src/index.js",
+  "unpkg": "./dist/dist.js",
+  "browser": "./dist/dist.js",
   "keywords": [
-    "litecanvas"
+    "litecanvas",
+    "migration",
+    "compatibility"
   ],
   "scripts": {
     "dev": "esbuild src/_web.js --bundle --watch --outfile=dist/dist.js --servedir=.",

package/src/index.js

@@ -1,6 +1,6 @@
 import "litecanvas"
 
-import { colrect, colcirc } from "@litecanvas/utils"
+import { colrect, colcirc, wave } from "@litecanvas/utils"
 
 const defaults = {
   warnings: true,
@@ -13,9 +13,14 @@ const defaults = {
  * @returns any
  */
 export default function plugin(engine, config = {}) {
-  config = Object.assign({}, defaults, config)
   const initialized = engine.stat(1)
 
+  if (initialized) {
+    throw 'Plugin Migrate should be loaded before the "init" event'
+  }
+
+  config = Object.assign({}, defaults, config)
+
   const replacements = {
     def: _def,
     seed,
@@ -39,26 +44,23 @@ export default function plugin(engine, config = {}) {
     paint,
 
     // restore collision utils
-    colrect,
-    colcirc,
-  }
-
-  if (initialized) {
-    throw 'Plugin Migrate should be loaded before the "init" event'
+    colrect: (...args) => {
+      warnUtils("colrect()")
+      return colrect(...args)
+    },
+    colcirc: (...args) => {
+      warnUtils("colrect()")
+      return colcirc(...args)
+    },
+    wave: (...args) => {
+      warnUtils("wave()")
+      return wave(...args)
+    },
   }
 
   /** @type {LitecanvasOptions} */
   const settings = engine.stat(0)
 
-  function warn(old, current, extra = "") {
-    if (config.warnings)
-      console.warn(
-        `[litecanvas/migrate] ${old} is removed. ` +
-          (current ? `Use ${current} instead. ` : "") +
-          extra
-      )
-  }
-
   function seed(value) {
     warn("seed()", "rseed()")
     if (value) {
@@ -328,5 +330,38 @@ export default function plugin(engine, config = {}) {
     }
   }
 
+  // restore `listen()` pre v0.200
+  const _core_unlisten = engine.unlisten
+  if (_core_unlisten) {
+    const _core_listen = engine.listen
+    replacements.listen = (eventName, callback) => {
+      _core_listen(eventName, callback)
+      return () => {
+        warnMessage(
+          "listen() not returns a function anymore. Please use unlisten(event, callback) instead"
+        )
+        _core_unlisten(eventName, callback)
+      }
+    }
+  }
+
+  function warnMessage(message) {
+    if (config.warnings) {
+      console.warn(`[litecanvas/migrate] ${message}.`)
+    }
+  }
+
+  function warn(old, current, extra = "") {
+    warnMessage(
+      `${old} is removed. ` +
+        (current ? `Please use ${current} instead. ` : "") +
+        extra
+    )
+  }
+
+  function warnUtils(func, type = "function") {
+    warn(func, `This ${type} was moved to @litecanvas/utils package.`)
+  }
+
   return replacements
 }