map-transform 1.3.0 → 1.4.0

package/README.md

@@ -1855,6 +1855,12 @@ props in `exclude`. Both `include` and `exclude` may be array of strings, and
 they should not be used in combination. If both are provided, `include` will be
 used.
 
+You may also specify an `includePath` or `excludePath`. These are dot notation
+paths to arrays of strings, and will be used instead of `include` or `exclude`.
+If `include` or `exclude` are also provided, they will be used as default
+values when the corresponding path yields no value. Note that "no value" here
+means `undefined`, and we don't support custom nonvalues here yet.
+
 When given an array of object, each object will be projected. When given
 anything that is not an object, undefined will be returned.
 

package/dist/transformers/project.d.ts

@@ -1,7 +1,9 @@
 import type { Transformer, TransformerProps } from '../types.js';
 export interface Props extends TransformerProps {
     include?: string[];
+    includePath?: string;
     exclude?: string[];
+    excludePath?: string;
 }
 declare const transformer: Transformer<Props>;
 export default transformer;

package/dist/transformers/project.js

@@ -1,5 +1,7 @@
 import mapAny from 'map-any';
+import { pathGetter } from '../operations/getSet.js';
 import { isObject, isString, isNonEmptyArray } from '../utils/is.js';
+import { ensureArray } from '../utils/array.js';
 const projectProps = (rawProps, doInclude) => {
     const props = rawProps.filter(isString);
     const filterFn = doInclude
@@ -7,13 +9,43 @@ const projectProps = (rawProps, doInclude) => {
         : ([key]) => !props.includes(key);
     return (obj) => Object.fromEntries(Object.entries(obj).filter(filterFn));
 };
-const transformer = function bucket({ include, exclude }) {
-    const projectFn = isNonEmptyArray(include)
-        ? projectProps(include, true)
-        : isNonEmptyArray(exclude)
-            ? projectProps(exclude, false)
-            : (obj) => obj;
-    return () => (data, state) => mapAny((data) => isObject(data) ? (state.rev ? data : projectFn(data)) : undefined, data);
+const projectPropsFromPath = (path, rawProps, doInclude) => {
+    const getFn = pathGetter(path);
+    return (obj, state) => {
+        let props = getFn(obj, state);
+        if (props === undefined) {
+            props = rawProps;
+        }
+        if (!props) {
+            return obj;
+        }
+        return projectProps(ensureArray(props), doInclude)(obj);
+    };
+};
+function prepareProjectFn(include, includePath, exclude, excludePath) {
+    if (typeof includePath === 'string') {
+        return projectPropsFromPath(includePath, include, true);
+    }
+    else if (typeof excludePath === 'string') {
+        return projectPropsFromPath(excludePath, exclude, false);
+    }
+    else if (isNonEmptyArray(include)) {
+        return projectProps(include, true);
+    }
+    else if (isNonEmptyArray(exclude)) {
+        return projectProps(exclude, false);
+    }
+    else {
+        return (obj) => obj;
+    }
+}
+const transformer = function bucket({ include, includePath, exclude, excludePath, }) {
+    const projectFn = prepareProjectFn(include, includePath, exclude, excludePath);
+    return () => (data, state) => mapAny((data) => isObject(data)
+        ? state.rev
+            ? data
+            : projectFn(data, state)
+        : undefined, data);
 };
 export default transformer;
 //# sourceMappingURL=project.js.map

package/dist/transformers/project.js.map

@@ -1 +1 @@
-{"version":3,"file":"project.js","sourceRoot":"","sources":["../../src/transformers/project.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,SAAS,CAAA;AAC5B,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAQpE,MAAM,YAAY,GAAG,CAAC,QAAkB,EAAE,SAAkB,EAAE,EAAE;IAC9D,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IACvC,MAAM,QAAQ,GAAG,SAAS;QACxB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAoB,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;QACnD,CAAC,CAAC,CAAC,CAAC,GAAG,CAAoB,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;IACtD,OAAO,CAAC,GAA4B,EAAE,EAAE,CACtC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;AAC5D,CAAC,CAAA;AAED,MAAM,WAAW,GAAuB,SAAS,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE;IAE1E,MAAM,SAAS,GAAG,eAAe,CAAC,OAAO,CAAC;QACxC,CAAC,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC;QAC7B,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC;YACxB,CAAC,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC;YAC9B,CAAC,CAAC,CAAC,GAA4B,EAAE,EAAE,CAAC,GAAG,CAAA;IAI3C,OAAO,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAC3B,MAAM,CACJ,CAAC,IAAI,EAAE,EAAE,CACP,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EACnE,IAAI,CACL,CAAA;AACL,CAAC,CAAA;AAED,eAAe,WAAW,CAAA"}
+{"version":3,"file":"project.js","sourceRoot":"","sources":["../../src/transformers/project.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,SAAS,CAAA;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACpD,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAU/C,MAAM,YAAY,GAAG,CAAC,QAAmB,EAAE,SAAkB,EAAE,EAAE;IAC/D,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IACvC,MAAM,QAAQ,GAAG,SAAS;QACxB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAoB,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;QACnD,CAAC,CAAC,CAAC,CAAC,GAAG,CAAoB,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;IACtD,OAAO,CAAC,GAA4B,EAAE,EAAE,CACtC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;AAC5D,CAAC,CAAA;AAED,MAAM,oBAAoB,GAAG,CAC3B,IAAY,EACZ,QAA+B,EAC/B,SAAkB,EAClB,EAAE;IACF,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAA;IAC9B,OAAO,CAAC,GAA4B,EAAE,KAAY,EAAE,EAAE;QACpD,IAAI,KAAK,GAAG,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QAC7B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,KAAK,GAAG,QAAQ,CAAA;QAClB,CAAC;QACD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,GAAG,CAAA;QACZ,CAAC;QACD,OAAO,YAAY,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,CAAA;IACzD,CAAC,CAAA;AACH,CAAC,CAAA;AAED,SAAS,gBAAgB,CACvB,OAAkB,EAClB,WAAoB,EACpB,OAAkB,EAClB,WAAoB;IAEpB,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QACpC,OAAO,oBAAoB,CAAC,WAAW,EAAE,OAAO,EAAE,IAAI,CAAC,CAAA;IACzD,CAAC;SAAM,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QAC3C,OAAO,oBAAoB,CAAC,WAAW,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;IAC1D,CAAC;SAAM,IAAI,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;QACpC,OAAO,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;IACpC,CAAC;SAAM,IAAI,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;QACpC,OAAO,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;IACrC,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAA4B,EAAE,EAAE,CAAC,GAAG,CAAA;IAC9C,CAAC;AACH,CAAC;AAED,MAAM,WAAW,GAAuB,SAAS,MAAM,CAAC,EACtD,OAAO,EACP,WAAW,EACX,OAAO,EACP,WAAW,GACZ;IAEC,MAAM,SAAS,GAAG,gBAAgB,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAA;IAI9E,OAAO,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAC3B,MAAM,CACJ,CAAC,IAAI,EAAE,EAAE,CACP,QAAQ,CAAC,IAAI,CAAC;QACZ,CAAC,CAAC,KAAK,CAAC,GAAG;YACT,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC;QAC1B,CAAC,CAAC,SAAS,EACf,IAAI,CACL,CAAA;AACL,CAAC,CAAA;AAED,eAAe,WAAW,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "map-transform",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Map and transform objects with mapping definitions",
   "author": "Kjell-Morten Bratsberg Thorsen <kjellmorten@integreat.io>",
   "license": "ISC",
@@ -55,7 +55,7 @@
   "devDependencies": {
     "@integreat/ts-dev-setup": "^5.0.4",
     "@types/deep-freeze": "^0.1.5",
-    "@types/sinon": "^17.0.2",
+    "@types/sinon": "^17.0.3",
     "deep-freeze": "0.0.1",
     "sinon": "^17.0.1"
   }