inferred-types 0.28.2 → 0.28.4

package/dist/index.d.ts

@@ -830,6 +830,11 @@ interface MapConfig<IR extends OptRequired | undefined = undefined, D extends Ma
     input?: IR;
     output?: OR;
     cardinality?: D;
+    /**
+     * Whether calls to the final `MapFn` will be logged to stderr
+     * for debugging purposes. Defaults to false.
+     */
+    debug?: boolean;
 }
 /**
  * A finalized configuration of a **mapTo** mapper functions cardinality
@@ -838,7 +843,7 @@ 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, D extends MapCardinalityIllustrated, OR extends OptRequired> = Required<MapConfig<IR, D, OR>> & {
+declare type FinalizedMapConfig<IR extends OptRequired = MapIR<DefaultOneToManyMapping>, D extends MapCardinalityIllustrated = MapCard<DefaultOneToManyMapping>, OR extends OptRequired = MapOR<DefaultOneToManyMapping>> = Required<MapConfig<IR, D, OR>> & {
     finalized: true;
 };
 /**
@@ -846,8 +851,15 @@ declare type FinalizedMapConfig<IR extends OptRequired, D extends MapCardinality
  * cardinality already (e.g., `oneToMany()`, `manyToOne()`)
  */
 declare type MapCardinalityConfig<IR extends OptRequired | undefined, OR extends OptRequired | undefined> = {
+    /** whether we the input can _optionally_ be an `undefined` value or not */
     input?: IR;
+    /** whether we the output can _optionally_ be an `undefined` value or not */
     output?: OR;
+    /**
+     * Whether calls to the final `MapFn` will be logged to stderr
+     * for debugging purposes. Defaults to false.
+     */
+    debug?: boolean;
 };
 /**
  * **ConfiguredMap**

package/dist/index.js

@@ -615,9 +615,33 @@ 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) {
-      return source.flatMap(map);
+      const output = source.flatMap(map);
+      if (config.debug) {
+        console.error(
+          `MapFn[${config.input}, ${config.cardinality}, ${config.output}] received:
+
+${JSON.stringify(source)}
+
+And produced: ${JSON.stringify(
+            output
+          )}
+
+`
+        );
+      }
+      return output;
     } else {
-      return map(source);
+      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)}
+`
+        );
+      }
+      return output;
     }
   };
 };

package/dist/index.mjs

@@ -524,9 +524,33 @@ 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) {
-      return source.flatMap(map);
+      const output = source.flatMap(map);
+      if (config.debug) {
+        console.error(
+          `MapFn[${config.input}, ${config.cardinality}, ${config.output}] received:
+
+${JSON.stringify(source)}
+
+And produced: ${JSON.stringify(
+            output
+          )}
+
+`
+        );
+      }
+      return output;
     } else {
-      return map(source);
+      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)}
+`
+        );
+      }
+      return output;
     }
   };
 };

package/package.json

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

package/src/types/dictionary/MapTo.ts

@@ -35,6 +35,11 @@ export interface MapConfig<
   input?: IR;
   output?: OR;
   cardinality?: D;
+  /**
+   * Whether calls to the final `MapFn` will be logged to stderr
+   * for debugging purposes. Defaults to false.
+   */
+  debug?: boolean;
 }
 
 /**
@@ -45,9 +50,9 @@ export interface MapConfig<
  * configuration between the input and output._
  */
 export type FinalizedMapConfig<
-  IR extends OptRequired,
-  D extends MapCardinalityIllustrated,
-  OR extends OptRequired
+  IR extends OptRequired = MapIR<DefaultOneToManyMapping>,
+  D extends MapCardinalityIllustrated = MapCard<DefaultOneToManyMapping>,
+  OR extends OptRequired = MapOR<DefaultOneToManyMapping>
 > = Required<MapConfig<IR, D, OR>> & { finalized: true };
 
 /**
@@ -58,8 +63,15 @@ type MapCardinalityConfig<
   IR extends OptRequired | undefined,
   OR extends OptRequired | undefined
 > = {
+  /** whether we the input can _optionally_ be an `undefined` value or not */
   input?: IR;
+  /** whether we the output can _optionally_ be an `undefined` value or not */
   output?: OR;
+  /**
+   * Whether calls to the final `MapFn` will be logged to stderr
+   * for debugging purposes. Defaults to false.
+   */
+  debug?: boolean;
 };
 
 /**

package/src/utility/dictionary/mapTo.ts

@@ -77,11 +77,30 @@ const mapper =
         // item and this approach achieves this.
         // TODO: we should check that the approach below doesn't work for M:1 here
         // as well
-        return (source as any).flatMap(map) as MapFnOutput<I, O, S, MapOR<C>, MapCard<C>>;
+        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`
+          );
+        }
+
+        return output;
       } else {
         // receive _all_ inputs provided as pass into ; this is just a single input unless the
         // cardinality is
-        return map(source as any) as MapFnOutput<I, O, S, MapOR<C>, MapCard<C>>;
+        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`
+          );
+        }
+        return output;
       }
     };
   };

package/tests/dictionary/mapTo.test.ts

@@ -319,6 +319,26 @@ describe("mapTo() utility function", () => {
     o.map((item) => expect("title" in item).toBeTruthy());
   });
 
+  it("1:M conversion with filtering", () => {
+    const m = mapTo<I, O>((i) =>
+      i.title === "i2" ? [{ title: i.title, count: i.products.length }] : []
+    );
+    const o = m([i, i2]);
+
+    expect(o.length).toBe(1);
+    o.map((item) => expect(item.title).toBe("i2"));
+  });
+
+  it("1:M conversion with filtering and debugging", () => {
+    const m = mapTo
+      .config({ debug: true })
+      .map<I, O>((i) => (i.title === "i2" ? [{ title: i.title, count: i.products.length }] : []));
+    const o = m([i, i2]);
+
+    expect(o.length).toBe(1);
+    o.map((item) => expect(item.title).toBe("i2"));
+  });
+
   it("M:1 conversion", () => {
     const m = mapTo.config({ output: "req", cardinality: "I[] -> O" }).map<I, O>((i) => {
       return {