inferred-types 0.28.4 → 0.28.5

package/dist/index.d.ts

@@ -832,9 +832,11 @@ interface MapConfig<IR extends OptRequired | undefined = undefined, D extends Ma
     cardinality?: D;
     /**
      * Whether calls to the final `MapFn` will be logged to stderr
-     * for debugging purposes. Defaults to false.
+     * for debugging purposes. Defaults to false; if you specify
+     * a _string_ for a value that will be sent to stderr along
+     * with other debugging info.
      */
-    debug?: boolean;
+    debug?: boolean | string;
 }
 /**
  * A finalized configuration of a **mapTo** mapper functions cardinality
@@ -843,8 +845,9 @@ interface MapConfig<IR extends OptRequired | undefined = undefined, D extends Ma
  * Note: _this configuration does _not_ yet include the actual mapping
  * configuration between the input and output._
  */
-declare type FinalizedMapConfig<IR extends OptRequired = MapIR<DefaultOneToManyMapping>, D extends MapCardinalityIllustrated = MapCard<DefaultOneToManyMapping>, OR extends OptRequired = MapOR<DefaultOneToManyMapping>> = Required<MapConfig<IR, D, OR>> & {
+declare type FinalizedMapConfig<IR extends OptRequired = MapIR<DefaultOneToManyMapping>, D extends MapCardinalityIllustrated = MapCard<DefaultOneToManyMapping>, OR extends OptRequired = MapOR<DefaultOneToManyMapping>> = Required<Omit<MapConfig<IR, D, OR>, "debug">> & {
     finalized: true;
+    debug: boolean | string;
 };
 /**
  * User configuration exposed by a config function which specifies the
@@ -857,9 +860,10 @@ declare type MapCardinalityConfig<IR extends OptRequired | undefined, OR extends
     output?: OR;
     /**
      * Whether calls to the final `MapFn` will be logged to stderr
-     * for debugging purposes. Defaults to false.
+     * for debugging purposes. Defaults to false; if you set to a string
+     * value than this will be echoed out with stderr.
      */
-    debug?: boolean;
+    debug?: boolean | string;
 };
 /**
  * **ConfiguredMap**
@@ -873,6 +877,7 @@ declare type ConfiguredMap<C extends FinalizedMapConfig<OptRequired, MapCardinal
     input: MapIR<C>;
     cardinality: MapCard<C>;
     output: MapOR<C>;
+    debug: boolean | string;
 };
 /**
  * Extracts the IR, Cardinality, and OR generics from a FinalizedMapConfig

package/dist/index.js

@@ -611,36 +611,31 @@ var DEFAULT_MANY_TO_ONE_MAPPING = toFinalizedConfig({
   output: "req",
   cardinality: "I[] -> O"
 });
-var mapper = (config) => (map) => {
-  return (source) => {
-    const isArray2 = config.cardinality === "I -> O[]" && Array.isArray(source) ? true : config.cardinality === "I[] -> O" && Array.isArray(source) && Array.isArray(source[0]) ? true : false;
-    if (isArray2) {
-      const output = source.flatMap(map);
-      if (config.debug) {
-        console.error(
-          `MapFn[${config.input}, ${config.cardinality}, ${config.output}] received:
+var debugMsg = (config, source, output) => {
+  if (config.debug) {
+    console.error(
+      `MapFn[${typeof config.output === "string" ? `${config.output}, ` : ""}${config.input}, ${config.cardinality}, ${config.output}] received:
 
 ${JSON.stringify(source)}
 
 And produced: ${JSON.stringify(
-            output
-          )}
+        output
+      )}
 
 `
-        );
-      }
+    );
+  }
+};
+var mapper = (config) => (map) => {
+  return (source) => {
+    const isArray2 = config.cardinality === "I -> O[]" && Array.isArray(source) ? true : config.cardinality === "I[] -> O" && Array.isArray(source) && Array.isArray(source[0]) ? true : false;
+    if (isArray2) {
+      const output = source.flatMap(map);
+      debugMsg(config, source, output);
       return output;
     } else {
       const output = map(source);
-      if (config.debug) {
-        console.error(
-          `MapFn[${config.input}, ${config.cardinality}, ${config.output}] received:
-
-${JSON.stringify(source)}
-And produced: ${JSON.stringify(output)}
-`
-        );
-      }
+      debugMsg(config, source, output);
       return output;
     }
   };
@@ -655,7 +650,8 @@ var setMapper = (config = { input: void 0, output: void 0, cardinality: void 0 }
   },
   input: (config == null ? void 0 : config.input) || defaultValue.input,
   output: (config == null ? void 0 : config.output) || defaultValue.output,
-  cardinality: (config == null ? void 0 : config.cardinality) || defaultValue.cardinality
+  cardinality: (config == null ? void 0 : config.cardinality) || defaultValue.cardinality,
+  debug: (config == null ? void 0 : config.debug) || false
 });
 var mapToFn = (map) => {
   return mapper(DEFAULT_ONE_TO_MANY_MAPPING)(map);

package/dist/index.mjs

@@ -520,36 +520,31 @@ var DEFAULT_MANY_TO_ONE_MAPPING = toFinalizedConfig({
   output: "req",
   cardinality: "I[] -> O"
 });
-var mapper = (config) => (map) => {
-  return (source) => {
-    const isArray2 = config.cardinality === "I -> O[]" && Array.isArray(source) ? true : config.cardinality === "I[] -> O" && Array.isArray(source) && Array.isArray(source[0]) ? true : false;
-    if (isArray2) {
-      const output = source.flatMap(map);
-      if (config.debug) {
-        console.error(
-          `MapFn[${config.input}, ${config.cardinality}, ${config.output}] received:
+var debugMsg = (config, source, output) => {
+  if (config.debug) {
+    console.error(
+      `MapFn[${typeof config.output === "string" ? `${config.output}, ` : ""}${config.input}, ${config.cardinality}, ${config.output}] received:
 
 ${JSON.stringify(source)}
 
 And produced: ${JSON.stringify(
-            output
-          )}
+        output
+      )}
 
 `
-        );
-      }
+    );
+  }
+};
+var mapper = (config) => (map) => {
+  return (source) => {
+    const isArray2 = config.cardinality === "I -> O[]" && Array.isArray(source) ? true : config.cardinality === "I[] -> O" && Array.isArray(source) && Array.isArray(source[0]) ? true : false;
+    if (isArray2) {
+      const output = source.flatMap(map);
+      debugMsg(config, source, output);
       return output;
     } else {
       const output = map(source);
-      if (config.debug) {
-        console.error(
-          `MapFn[${config.input}, ${config.cardinality}, ${config.output}] received:
-
-${JSON.stringify(source)}
-And produced: ${JSON.stringify(output)}
-`
-        );
-      }
+      debugMsg(config, source, output);
       return output;
     }
   };
@@ -564,7 +559,8 @@ var setMapper = (config = { input: void 0, output: void 0, cardinality: void 0 }
   },
   input: (config == null ? void 0 : config.input) || defaultValue.input,
   output: (config == null ? void 0 : config.output) || defaultValue.output,
-  cardinality: (config == null ? void 0 : config.cardinality) || defaultValue.cardinality
+  cardinality: (config == null ? void 0 : config.cardinality) || defaultValue.cardinality,
+  debug: (config == null ? void 0 : config.debug) || false
 });
 var mapToFn = (map) => {
   return mapper(DEFAULT_ONE_TO_MANY_MAPPING)(map);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "inferred-types",
-  "version": "0.28.4",
+  "version": "0.28.5",
   "description": "Functions which provide useful type inference on TS projects",
   "license": "MIT",
   "author": "Ken Snyder<ken@ken.net>",

package/src/types/dictionary/MapTo.ts

@@ -37,9 +37,11 @@ export interface MapConfig<
   cardinality?: D;
   /**
    * Whether calls to the final `MapFn` will be logged to stderr
-   * for debugging purposes. Defaults to false.
+   * for debugging purposes. Defaults to false; if you specify
+   * a _string_ for a value that will be sent to stderr along
+   * with other debugging info.
    */
-  debug?: boolean;
+  debug?: boolean | string;
 }
 
 /**
@@ -53,7 +55,7 @@ export type FinalizedMapConfig<
   IR extends OptRequired = MapIR<DefaultOneToManyMapping>,
   D extends MapCardinalityIllustrated = MapCard<DefaultOneToManyMapping>,
   OR extends OptRequired = MapOR<DefaultOneToManyMapping>
-> = Required<MapConfig<IR, D, OR>> & { finalized: true };
+> = Required<Omit<MapConfig<IR, D, OR>, "debug">> & { finalized: true; debug: boolean | string };
 
 /**
  * User configuration exposed by a config function which specifies the
@@ -69,9 +71,10 @@ type MapCardinalityConfig<
   output?: OR;
   /**
    * Whether calls to the final `MapFn` will be logged to stderr
-   * for debugging purposes. Defaults to false.
+   * for debugging purposes. Defaults to false; if you set to a string
+   * value than this will be echoed out with stderr.
    */
-  debug?: boolean;
+  debug?: boolean | string;
 };
 
 /**
@@ -88,6 +91,7 @@ export type ConfiguredMap<
   input: MapIR<C>;
   cardinality: MapCard<C>;
   output: MapOR<C>;
+  debug: boolean | string;
 };
 
 /**

package/src/utility/dictionary/mapTo.ts

@@ -49,6 +49,22 @@ export type DefaultOneToManyMapping = typeof DEFAULT_ONE_TO_MANY_MAPPING;
 export type DefaultOneToOneMapping = typeof DEFAULT_ONE_TO_ONE_MAPPING;
 export type DefaultManyToOneMapping = typeof DEFAULT_MANY_TO_ONE_MAPPING;
 
+const debugMsg = <C extends FinalizedMapConfig<any, any, any>>(
+  config: C,
+  source: any,
+  output: any
+) => {
+  if (config.debug) {
+    console.error(
+      `MapFn[${typeof config.output === "string" ? `${config.output}, ` : ""}${config.input}, ${
+        config.cardinality
+      }, ${config.output}] received:\n\n${JSON.stringify(source)}\n\nAnd produced: ${JSON.stringify(
+        output
+      )}\n\n`
+    );
+  }
+};
+
 /**
  * The single implementation for all mapping
  */
@@ -78,28 +94,14 @@ const mapper =
         // TODO: we should check that the approach below doesn't work for M:1 here
         // as well
         const output = (source as any).flatMap(map) as MapFnOutput<I, O, S, MapOR<C>, MapCard<C>>;
-        if (config.debug) {
-          console.error(
-            `MapFn[${config.input}, ${config.cardinality}, ${
-              config.output
-            }] received:\n\n${JSON.stringify(source)}\n\nAnd produced: ${JSON.stringify(
-              output
-            )}\n\n`
-          );
-        }
+        debugMsg(config, source, output);
 
         return output;
       } else {
         // receive _all_ inputs provided as pass into ; this is just a single input unless the
         // cardinality is
         const output = map(source as any) as MapFnOutput<I, O, S, MapOR<C>, MapCard<C>>;
-        if (config.debug) {
-          console.error(
-            `MapFn[${config.input}, ${config.cardinality}, ${
-              config.output
-            }] received:\n\n${JSON.stringify(source)}\nAnd produced: ${JSON.stringify(output)}\n`
-          );
-        }
+        debugMsg(config, source, output);
         return output;
       }
     };
@@ -131,6 +133,7 @@ const setMapper = <
   input: config?.input || defaultValue.input,
   output: config?.output || defaultValue.output,
   cardinality: config?.cardinality || defaultValue.cardinality,
+  debug: config?.debug || false,
 });
 
 /**