inferred-types 0.28.3 → 0.28.5

package/dist/index.d.ts

@@ -830,6 +830,13 @@ 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; if you specify
+     * a _string_ for a value that will be sent to stderr along
+     * with other debugging info.
+     */
+    debug?: boolean | string;
 }
 /**
  * A finalized configuration of a **mapTo** mapper functions cardinality
@@ -838,16 +845,25 @@ 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
  * 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; if you set to a string
+     * value than this will be echoed out with stderr.
+     */
+    debug?: boolean | string;
 };
 /**
  * **ConfiguredMap**
@@ -861,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,13 +611,32 @@ var DEFAULT_MANY_TO_ONE_MAPPING = toFinalizedConfig({
   output: "req",
   cardinality: "I[] -> O"
 });
+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
+      )}
+
+`
+    );
+  }
+};
 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);
+      debugMsg(config, source, output);
+      return output;
     } else {
-      return map(source);
+      const output = map(source);
+      debugMsg(config, source, output);
+      return output;
     }
   };
 };
@@ -631,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,13 +520,32 @@ var DEFAULT_MANY_TO_ONE_MAPPING = toFinalizedConfig({
   output: "req",
   cardinality: "I[] -> O"
 });
+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
+      )}
+
+`
+    );
+  }
+};
 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);
+      debugMsg(config, source, output);
+      return output;
     } else {
-      return map(source);
+      const output = map(source);
+      debugMsg(config, source, output);
+      return output;
     }
   };
 };
@@ -540,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.3",
+  "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

@@ -35,6 +35,13 @@ 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; if you specify
+   * a _string_ for a value that will be sent to stderr along
+   * with other debugging info.
+   */
+  debug?: boolean | string;
 }
 
 /**
@@ -48,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
@@ -58,8 +65,16 @@ 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; if you set to a string
+   * value than this will be echoed out with stderr.
+   */
+  debug?: boolean | string;
 };
 
 /**
@@ -76,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
  */
@@ -77,11 +93,16 @@ 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>>;
+        debugMsg(config, source, output);
+
+        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>>;
+        debugMsg(config, source, output);
+        return output;
       }
     };
   };
@@ -112,6 +133,7 @@ const setMapper = <
   input: config?.input || defaultValue.input,
   output: config?.output || defaultValue.output,
   cardinality: config?.cardinality || defaultValue.cardinality,
+  debug: config?.debug || false,
 });
 
 /**

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 {