@ixfx/debug 0.40.0 → 0.41.0

package/LICENSE

@@ -77,26 +77,14 @@ SOFTWARE.
 
 ----
 
-Package: colorjs.io
+Package: colorizr
 
-MIT License
+https://github.com/gilbarbara/colorizr
 
-Copyright (c) 2021 Lea Verou, Chris Lilley
+Copyright (c) 2015 Gil Barbara
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/bundle/index.d.ts

@@ -0,0 +1,129 @@
+//#region src/types.d.ts
+type LogSet = {
+  readonly log: MessageLogger;
+  readonly warn: MessageLogger;
+  readonly error: MessageLogger;
+};
+type MessageLogger = (message: LogMessage | string) => void;
+type LogKind = `info` | `debug` | `error` | `warn`;
+type LogMessage = {
+  readonly kind?: LogKind;
+  readonly msg: any;
+  readonly category?: string;
+};
+//# sourceMappingURL=types.d.ts.map
+
+//#endregion
+//#region src/logger.d.ts
+/**
+ * Returns a console logging function which prefixes messages. This is
+ * useful for tracing messages from different components. Each prefix
+ * is assigned a colour, further helping to distinguish messages.
+ *
+ * Use {@link logSet} to get a bundled set.
+ *
+ * ```
+ * // Initialise once
+ * const log = logger(`a`);
+ * const error = logger(`a`, `error`);
+ * const warn = logger(`a`, `warn);
+ *
+ * // And then use
+ * log(`Hello`);    // console.log(`a Hello`);
+ * error(`Uh-oh`);  // console.error(`a Uh-oh`);
+ * warn(`Eek!`);    // console.warn(`a Eeek!`);
+ * ```
+ *
+ * Provide the `colourKey` parameter to make log messages
+ * be coloured the same, even though the prefix is different.
+ * ```js
+ * // Both loggers will use the same colour because they
+ * // share the colour key `system`
+ * const log = logger(`a`,`log`,`system`);
+ * const log2 = logger(`b`, `log`, `system`);
+ * ```
+ * @param prefix
+ * @param kind
+ * @param colourKey Optional key to colour log lines by instead of prefix
+ * @returns
+ */
+declare const logger: (prefix: string, kind?: `log` | `warn` | `error`, colourKey?: string) => MessageLogger;
+/**
+* Returns a bundled collection of {@link logger}s
+*
+* ```js
+* const con = logSet(`a`);
+* con.log(`Hello`);  // console.log(`a Hello`);
+* con.warn(`Uh-oh`); // console.warn(`a Uh-oh`);
+* con.error(`Eek!`); // console.error(`a Eek!`);
+* ```
+*
+* By default each prefix is assigned a colour. To use
+* another logic, provide the `colourKey` parameter.
+*
+* ```js
+* // Both set of loggers will use same colour
+* const con = logSet(`a`, true, `system`);
+* const con2 = logSet(`b`, true, `system`);
+* ```
+* @param prefix Prefix for log messages
+* @param verbose True by default. If false, log() messages are a no-op
+* @param colourKey If specified, log messages will be coloured by this key instead of prefix (default)
+* @returns
+*/
+declare const logSet: (prefix: string, verbose?: boolean, colourKey?: string) => {
+  log: MessageLogger;
+  warn: MessageLogger;
+  error: MessageLogger;
+};
+/**
+ * Either a flag for default console logging, or a simple log function
+ */
+type LogOption = boolean | MessageLogger;
+/**
+ * Resolve a LogOption to a function
+ * @param l
+ * @returns
+ */
+declare const resolveLogOption: (l?: LogOption, defaults?: {
+  readonly category?: string;
+  readonly kind?: string;
+}) => MessageLogger;
+declare const logColours: (key: string, args?: unknown) => string;
+//# sourceMappingURL=logger.d.ts.map
+//#endregion
+//#region src/fps-counter.d.ts
+/**
+ * Calculates frames per second.
+ *
+ * Returns a function which needs to be called at the end of each frame.
+ *
+ * ```js
+ * const fps = fpsCounter();
+ *
+ * function loop() {
+ *  fps(); // Calculate fps
+ *  window.requestAnimationFrame(loop);
+ * }
+ *
+ * loop();
+ * ```
+ * @param autoDisplay If true (default), prints out the FPS to the console
+ * @param computeAfterFrames Calculates after this many frames. Higher numbers smoothes the value somewhat
+ * @returns
+ */
+declare const fpsCounter: (autoDisplay?: boolean, computeAfterFrames?: number) => () => number;
+//# sourceMappingURL=fps-counter.d.ts.map
+//#endregion
+//#region src/error-message.d.ts
+/**
+ * Returns a string representation of an error
+ * @param ex
+ * @returns
+ */
+declare const getErrorMessage: (ex: unknown) => string;
+//# sourceMappingURL=error-message.d.ts.map
+
+//#endregion
+export { LogKind, LogMessage, LogOption, LogSet, MessageLogger, fpsCounter, getErrorMessage, logColours, logSet, logger, resolveLogOption };
+//# sourceMappingURL=index.d.ts.map

package/bundle/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/logger.ts","../src/fps-counter.ts","../src/error-message.ts"],"sourcesContent":[],"mappings":";KAAY,MAAA;EAAA,SAAM,GAAA,EACF,aADE;EAAA,SAAA,IAAA,EAED,aAFC;EAAA,SACF,KAAA,EAEE,aAFF;CAAa;AAEX,KAEN,aAAA,GAFM,CAAA,OAAA,EAEoB,UAFpB,GAAA,MAAA,EAAA,GAAA,IAAA;AAAa,KAGnB,OAAA,GAHmB,MAAA,GAAA,OAAA,GAAA,OAAA,GAAA,MAAA;AAEnB,KAEA,UAAA,GAFa;EACb,SAAA,IAAO,CAAA,EAED,OAFC;EACP,SAAA,GAAA,EAAU,GAAA;;;;;;;AAPtB;;;;;AAG+B;AAE/B;AACA;AACA;;;;ACgCA;AAqDA;;;;;;AAqBA;AAOA;;;;AAwCC;AAID;;;;ACjJA;;;cDoBa,iFAKR;AEvCL;;;;;;;;;;;;;;;;;;;;;;;cFuFa;OAgBZ;;;;;;;KAKW,SAAA,aAAsB;;;;;;cAOrB,uBACP;;;MAEH;cAyCU;;;;;ADpKb;;;;;AAG+B;AAE/B;AACA;AACA;;;;ACgCA;AAqDA;;;;;cCzEa;AD8Fb;;;;ADjHA;;;;AAGkB,cGEL,eHFK,EAAA,CAAA,EAAA,EAAA,OAAA,EAAA,GAAA,MAAA;AAAa"}

package/bundle/index.js

@@ -0,0 +1,2 @@
+const e=(e,t)=>(n,r)=>{let i=e.get(n);return i===void 0?(i=t(n,r),e.set(n,i),i):i},t=(e,t=`log`,n)=>r=>{r===void 0?r=`(undefined)`:typeof r==`object`&&(r=JSON.stringify(r));let i=n??e;switch(t){case`log`:console.log(`%c${e} ${r}`,`color: ${a(i)}`);break;case`warn`:console.warn(e,r);break;case`error`:console.error(e,r);break}},n=(e,n=!0,r)=>n?{log:t(e,`log`,r),warn:t(e,`warn`,r),error:t(e,`error`,r)}:{log:e=>{},warn:t(e,`warn`,r),error:t(e,`error`,r)},r=(e,t={})=>{if(e===void 0||typeof e==`boolean`&&!e)return e=>{};let n=t.category??``,r=t.kind??void 0;return typeof e==`boolean`?e=>{let t=typeof e==`string`?{msg:e}:e,i=t.kind??r,a=t.category??n,o=t.msg;switch(a&&(o=`[${a}] ${o}`),i){case`error`:console.error(o);break;case`warn`:console.warn(o);break;case`info`:console.info(o);break;default:console.log(o)}}:e};let i=0;const a=e(new Map,()=>{let e=++i*137.508;return`hsl(${e},50%,75%)`}),o=(e=!0,t=500)=>{let n=0,r=0,i=performance.now();return()=>{if(n++>=t){let a=performance.now()-i;i=performance.now(),n=0,r=Math.floor(t/a*1e3),e&&console.log(`fps: ${r}`)}return r}},s=e=>typeof e==`string`?e:e instanceof Error?e.message:e;export{o as fpsCounter,s as getErrorMessage,a as logColours,n as logSet,t as logger,r as resolveLogOption};
+//# sourceMappingURL=index.js.map

package/bundle/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["map: Map<K, V>","fn: (key: K, args?: Z) => V","key: K","args?: Z","prefix: string","kind: `log` | `warn` | `error`","colourKey?: string","m: any","_: any","l?: LogOption","defaults: { readonly category?: string; readonly kind?: string }","_: LogMessage | string","messageOrString: LogMessage | string","ex: unknown"],"sources":["../src/util.ts","../src/logger.ts","../src/fps-counter.ts","../src/error-message.ts"],"sourcesContent":["export const getOrGenerateSync =\n  <K, V, Z>(map: Map<K, V>, fn: (key: K, args?: Z) => V) =>\n    (key: K, args?: Z): V => {\n      let value = map.get(key);\n      if (value !== undefined) return value;\n      value = fn(key, args);\n      map.set(key, value);\n      return value;\n    };","import type { MessageLogger, LogMessage } from \"./types.js\";\nimport { getOrGenerateSync } from \"./util.js\";\n\n/**\n * Returns a console logging function which prefixes messages. This is\n * useful for tracing messages from different components. Each prefix\n * is assigned a colour, further helping to distinguish messages.\n *\n * Use {@link logSet} to get a bundled set.\n *\n * ```\n * // Initialise once\n * const log = logger(`a`);\n * const error = logger(`a`, `error`);\n * const warn = logger(`a`, `warn);\n *\n * // And then use\n * log(`Hello`);    // console.log(`a Hello`);\n * error(`Uh-oh`);  // console.error(`a Uh-oh`);\n * warn(`Eek!`);    // console.warn(`a Eeek!`);\n * ```\n *\n * Provide the `colourKey` parameter to make log messages\n * be coloured the same, even though the prefix is different.\n * ```js\n * // Both loggers will use the same colour because they\n * // share the colour key `system`\n * const log = logger(`a`,`log`,`system`);\n * const log2 = logger(`b`, `log`, `system`);\n * ```\n * @param prefix\n * @param kind\n * @param colourKey Optional key to colour log lines by instead of prefix\n * @returns\n */\n\n\n\n\nexport const logger =\n  (\n    prefix: string,\n    kind: `log` | `warn` | `error` = `log`,\n    colourKey?: string\n  ): MessageLogger =>\n    (m: any) => {\n      if (m === undefined) {\n        m = `(undefined)`;\n      } else if (typeof m === `object`) {\n        m = JSON.stringify(m);\n      }\n\n      const colour = colourKey ?? prefix;\n      switch (kind) {\n        case `log`: {\n          console.log(`%c${ prefix } ${ m }`, `color: ${ logColours(colour) }`);\n          break;\n        }\n        case `warn`: {\n          console.warn(prefix, m);\n          break;\n        }\n        case `error`: {\n          console.error(prefix, m);\n          break;\n        }\n      }\n    };\n\n/**\n* Returns a bundled collection of {@link logger}s\n*\n* ```js\n* const con = logSet(`a`);\n* con.log(`Hello`);  // console.log(`a Hello`);\n* con.warn(`Uh-oh`); // console.warn(`a Uh-oh`);\n* con.error(`Eek!`); // console.error(`a Eek!`);\n* ```\n*\n* By default each prefix is assigned a colour. To use\n* another logic, provide the `colourKey` parameter.\n*\n* ```js\n* // Both set of loggers will use same colour\n* const con = logSet(`a`, true, `system`);\n* const con2 = logSet(`b`, true, `system`);\n* ```\n* @param prefix Prefix for log messages\n* @param verbose True by default. If false, log() messages are a no-op\n* @param colourKey If specified, log messages will be coloured by this key instead of prefix (default)\n* @returns\n*/\nexport const logSet = (prefix: string, verbose = true, colourKey?: string) => {\n  if (verbose) {\n    return {\n      log: logger(prefix, `log`, colourKey),\n      warn: logger(prefix, `warn`, colourKey),\n      error: logger(prefix, `error`, colourKey),\n    };\n  }\n  return {\n\n    log: (_: any) => {\n      /** no-op */\n    },\n    warn: logger(prefix, `warn`, colourKey),\n    error: logger(prefix, `error`, colourKey),\n  };\n};\n\n/**\n * Either a flag for default console logging, or a simple log function\n */\nexport type LogOption = boolean | MessageLogger;\n\n/**\n * Resolve a LogOption to a function\n * @param l\n * @returns\n */\nexport const resolveLogOption = (\n  l?: LogOption,\n  defaults: { readonly category?: string; readonly kind?: string } = {}\n): MessageLogger => {\n  if (l === undefined || (typeof l === `boolean` && !l)) {\n    return (_: LogMessage | string) => {\n      /** no-op */\n    };\n  }\n  const defaultCat = defaults.category ?? ``;\n  const defaultKind = defaults.kind ?? undefined;\n\n  if (typeof l === `boolean`) {\n    return (messageOrString: LogMessage | string) => {\n      const m =\n        typeof messageOrString === `string` ? { msg: messageOrString } : messageOrString;\n      const kind = m.kind ?? defaultKind;\n      const category = m.category ?? defaultCat;\n      let message = m.msg;\n      if (category) message = `[${ category }] ${ message }`;\n      switch (kind) {\n        case `error`: {\n          console.error(message);\n          break;\n        }\n        case `warn`: {\n          console.warn(message);\n          break;\n        }\n        case `info`: {\n          console.info(message);\n          break;\n        }\n        default: {\n          console.log(message);\n        }\n      }\n    };\n  }\n  return l;\n};\n\n\nlet logColourCount = 0;\nexport const logColours = getOrGenerateSync(new Map<string, string>(), () => {\n  const hue = ++logColourCount * 137.508; // use golden angle approximation\n  return `hsl(${ hue },50%,75%)`;\n});","/**\n * Calculates frames per second.\n * \n * Returns a function which needs to be called at the end of each frame.\n * \n * ```js\n * const fps = fpsCounter();\n * \n * function loop() {\n *  fps(); // Calculate fps\n *  window.requestAnimationFrame(loop);\n * }\n * \n * loop();\n * ```\n * @param autoDisplay If true (default), prints out the FPS to the console\n * @param computeAfterFrames Calculates after this many frames. Higher numbers smoothes the value somewhat\n * @returns \n */\nexport const fpsCounter = (autoDisplay = true, computeAfterFrames = 500) => {\n  let count = 0;\n  let lastFps = 0;\n  let countStart = performance.now();\n\n  return () => {\n    if (count++ >= computeAfterFrames) {\n      const elapsed = performance.now() - countStart;\n      countStart = performance.now();\n      count = 0;\n      lastFps = Math.floor((computeAfterFrames / elapsed) * 1000);\n      if (autoDisplay) console.log(`fps: ${ lastFps }`);\n    }\n    return lastFps\n  }\n}","/**\n * Returns a string representation of an error\n * @param ex \n * @returns \n */\nexport const getErrorMessage = (ex: unknown): string => {\n  if (typeof ex === `string`) return ex;\n  if (ex instanceof Error) {\n    return ex.message;\n  }\n  return ex as string;\n};"],"mappings":"AAAA,MAAa,EACX,CAAUA,EAAgBC,IACxB,CAACC,EAAQC,IAAgB,CACvB,IAAI,EAAQ,EAAI,IAAI,EAAI,CAIxB,OAHI,IAAU,IAAA,IACd,EAAQ,EAAG,EAAK,EAAK,CACrB,EAAI,IAAI,EAAK,EAAM,CACZ,GAHyB,CAIjC,EC+BQ,EACX,CACEC,EACAC,EAAiC,MACjCC,IAEA,AAACC,GAAW,CACN,IAAM,IAAA,GACR,EAAI,cACK,OAAO,GAAM,WACtB,EAAI,KAAK,UAAU,EAAE,EAGvB,IAAM,EAAS,GAAa,EAC5B,OAAQ,EAAR,CACE,IAAK,MACH,QAAQ,IAAI,CAAC,EAAE,EAAG,EAAQ,CAAC,EAAG,GAAI,CAAE,CAAC,OAAO,EAAG,EAAW,EAAO,EAAG,CAAC,CACrE,MAEF,IAAK,OACH,QAAQ,KAAK,EAAQ,EAAE,CACvB,MAEF,IAAK,QACH,QAAQ,MAAM,EAAQ,EAAE,CACxB,KAEH,CACF,EAyBQ,EAAS,CAACH,EAAgB,EAAU,GAAME,IACjD,EACK,CACL,IAAK,EAAO,EAAQ,MAAO,EAAU,CACrC,KAAM,EAAO,EAAQ,OAAQ,EAAU,CACvC,MAAO,EAAO,EAAQ,QAAS,EAAU,AAC1C,EAEI,CAEL,IAAK,AAACE,GAAW,CAEhB,EACD,KAAM,EAAO,EAAQ,OAAQ,EAAU,CACvC,MAAO,EAAO,EAAQ,QAAS,EAAU,AAC1C,EAaU,EAAmB,CAC9BC,EACAC,EAAmE,CAAE,IACnD,CAClB,GAAI,IAAM,IAAA,IAAc,OAAO,GAAM,WAAa,CAAC,EACjD,MAAO,CAACC,GAA2B,CAElC,EAEH,IAAM,EAAa,EAAS,UAAY,GAClC,EAAc,EAAS,MAAQ,IAAA,GA6BrC,OA3BI,OAAO,GAAM,UACR,AAACC,GAAyC,CAC/C,IAAM,EACJ,OAAO,GAAoB,SAAW,CAAE,IAAK,CAAiB,EAAG,EAC7D,EAAO,EAAE,MAAQ,EACjB,EAAW,EAAE,UAAY,EAC3B,EAAU,EAAE,IAEhB,OADI,IAAU,EAAU,CAAC,CAAC,EAAG,EAAU,EAAE,EAAG,GAAU,EAC9C,EAAR,CACE,IAAK,QACH,QAAQ,MAAM,EAAQ,CACtB,MAEF,IAAK,OACH,QAAQ,KAAK,EAAQ,CACrB,MAEF,IAAK,OACH,QAAQ,KAAK,EAAQ,CACrB,MAEF,QACE,QAAQ,IAAI,EAAQ,AAEvB,CACF,EAEI,CACR,EAGD,IAAI,EAAiB,EACrB,MAAa,EAAa,EAAkB,IAAI,IAAuB,IAAM,CAC3E,IAAM,EAAM,EAAE,EAAiB,QAC/B,MAAO,CAAC,IAAI,EAAG,EAAK,SAAS,CAAC,AAC/B,EAAC,CCpJW,EAAa,CAAC,EAAc,GAAM,EAAqB,MAAQ,CAC1E,IAAI,EAAQ,EACR,EAAU,EACV,EAAa,YAAY,KAAK,CAElC,MAAO,IAAM,CACX,GAAI,KAAW,EAAoB,CACjC,IAAM,EAAU,YAAY,KAAK,CAAG,EACpC,EAAa,YAAY,KAAK,CAC9B,EAAQ,EACR,EAAU,KAAK,MAAO,EAAqB,EAAW,IAAK,CACvD,GAAa,QAAQ,IAAI,CAAC,KAAK,EAAG,GAAU,CAAC,AAClD,CACD,OAAO,CACR,CACF,EC7BY,EAAkB,AAACC,GAC1B,OAAO,GAAO,SAAiB,EAC/B,aAAc,MACT,EAAG,QAEL"}

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@ixfx/debug",
-  "version": "0.40.0",
+  "version": "0.41.0",
   "license": "MIT",
   "type": "module",
   "sideEffects": false,
   "files": [
-    "dist/"
+    "dist/",
+    "bundle/"
   ],
   "dependencies": {},
   "exports": {
@@ -14,5 +15,8 @@
       "import": "./dist/src/index.js"
     }
   },
+  "scripts": {
+    "package-bundle": "tsdown"
+  },
   "main": "dist/src/index.js"
 }