map-transform 1.2.0 → 1.4.0

package/README.md

@@ -1452,7 +1452,7 @@ and not the order of the items in the original array. When a path is given, the
 array will be set on this path.
 
 ```javascript
-const def40 = bucket({
+const def40 = transform(bucket({
   path: 'users[]',
   buckets: [
     {
@@ -1467,7 +1467,7 @@ const def40 = bucket({
       key: 'users',
     },
   ],
-})
+}))
 
 const data = {
   users: [
@@ -1500,9 +1500,9 @@ const mappedData = await mapper(data)
 Or by size:
 
 ```javascript
-const def41 = bucket({
+const def41 = transform(bucket({
   buckets: [{ key: 'top3', size: 3 }, { key: 'theOthers' }],
-})
+}))
 
 const data = ['user1', 'user2', 'user3', 'user4', 'user5', 'user6', 'user7']
 
@@ -1848,6 +1848,52 @@ const def21b = [
 ]
 ```
 
+#### `project({include, exclude})` transformer
+
+Will return an object with only the props specified in `include` or none of the
+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.
+
+As we cannot bring back the removed props when mapping in reverse, this
+transformer will pass on the object data as is in reverse.
+
+```javascript
+import { transform, transformers } from 'map-transform'
+const { project } = transformers
+
+const def42 = transform(project({ include: ['id', 'name'] }))
+
+const data = {
+  id: 'ent1',
+  name: 'Entry 1',
+  text: 'Do not include',
+  created: new Date('2023-12-01T00:00:00Z'),
+}
+
+const mapper = mapTransform(def42)
+const mappedData = await mapper(data)
+// --> {
+//   id: 'ent1',
+//   name: 'Entry 1',
+// }
+```
+
+You may also define this as an operation object:
+
+```javascript
+const def42b = { $transform: 'project', include: ['id', 'name'] }
+```
+
 #### `sort({asc, path})` transformer
 
 The `sort` transformer will sort the array at the given `path`, in the direction

package/dist/transformers/index.d.ts

@@ -12,6 +12,7 @@ declare const _default: {
     merge: import("../types.js").AsyncTransformer<import("./merge.js").Props>;
     mergeRev: import("../types.js").AsyncTransformer<import("./merge.js").Props>;
     not: import("../types.js").AsyncTransformer<import("../types.js").AsyncDataMapperWithOptions | import("../types.js").DataMapperWithOptions | import("./not.js").Props>;
+    project: import("../types.js").Transformer<import("./project.js").Props>;
     sort: import("../types.js").Transformer<import("./sort.js").Props>;
     value: import("../types.js").Transformer<unknown>;
 };

package/dist/transformers/index.js

@@ -9,6 +9,7 @@ import logical from './logical.js';
 import map from './map.js';
 import { merge, mergeRev } from './merge.js';
 import not from './not.js';
+import project from './project.js';
 import sort from './sort.js';
 export default {
     bucket,
@@ -24,6 +25,7 @@ export default {
     merge,
     mergeRev,
     not,
+    project,
     sort,
     value,
 };

package/dist/transformers/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/transformers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACzC,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,OAAO,MAAM,cAAc,CAAA;AAClC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC/C,OAAO,OAAO,MAAM,cAAc,CAAA;AAClC,OAAO,GAAG,MAAM,UAAU,CAAA;AAC1B,OAAO,KAAK,MAAM,cAAc,CAAA;AAChC,OAAO,OAAO,MAAM,cAAc,CAAA;AAClC,OAAO,GAAG,MAAM,UAAU,CAAA;AAC1B,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAC5C,OAAO,GAAG,MAAM,UAAU,CAAA;AAC1B,OAAO,IAAI,MAAM,WAAW,CAAA;AAE5B,eAAe;IACb,MAAM;IACN,OAAO;IACP,OAAO;IACP,KAAK;IACL,OAAO;IACP,GAAG;IACH,OAAO;IACP,KAAK;IACL,OAAO;IACP,GAAG;IACH,KAAK;IACL,QAAQ;IACR,GAAG;IACH,IAAI;IACJ,KAAK;CACN,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/transformers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACzC,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,OAAO,MAAM,cAAc,CAAA;AAClC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC/C,OAAO,OAAO,MAAM,cAAc,CAAA;AAClC,OAAO,GAAG,MAAM,UAAU,CAAA;AAC1B,OAAO,KAAK,MAAM,cAAc,CAAA;AAChC,OAAO,OAAO,MAAM,cAAc,CAAA;AAClC,OAAO,GAAG,MAAM,UAAU,CAAA;AAC1B,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAC5C,OAAO,GAAG,MAAM,UAAU,CAAA;AAC1B,OAAO,OAAO,MAAM,cAAc,CAAA;AAClC,OAAO,IAAI,MAAM,WAAW,CAAA;AAE5B,eAAe;IACb,MAAM;IACN,OAAO;IACP,OAAO;IACP,KAAK;IACL,OAAO;IACP,GAAG;IACH,OAAO;IACP,KAAK;IACL,OAAO;IACP,GAAG;IACH,KAAK;IACL,QAAQ;IACR,GAAG;IACH,OAAO;IACP,IAAI;IACJ,KAAK;CACN,CAAA"}

package/dist/transformers/project.d.ts

@@ -0,0 +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

@@ -0,0 +1,51 @@
+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
+        ? ([key]) => props.includes(key)
+        : ([key]) => !props.includes(key);
+    return (obj) => Object.fromEntries(Object.entries(obj).filter(filterFn));
+};
+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

@@ -0,0 +1 @@
+{"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/dist/utils/is.d.ts

@@ -1,5 +1,7 @@
 export declare const isObject: (value: unknown) => value is Record<string, unknown>;
+export declare const isString: (value: unknown) => value is string;
 export declare const isPath: (value: unknown) => value is string;
 export declare const isArrayPath: (value: unknown) => value is string;
 export declare const isNullOrUndefined: (value: unknown) => value is null | undefined;
 export declare const isNotNullOrUndefined: <T>(value: T) => value is NonNullable<T>;
+export declare const isNonEmptyArray: <T>(value: unknown) => value is T[];

package/dist/utils/is.js

@@ -1,6 +1,8 @@
 export const isObject = (value) => Object.prototype.toString.call(value) === '[object Object]';
+export const isString = (value) => typeof value === 'string';
 export const isPath = (value) => typeof value === 'string';
 export const isArrayPath = (value) => isPath(value) && value.endsWith('[]');
 export const isNullOrUndefined = (value) => value === null || value === undefined;
 export const isNotNullOrUndefined = (value) => !isNullOrUndefined(value);
+export const isNonEmptyArray = (value) => Array.isArray(value) && value.length > 0;
 //# sourceMappingURL=is.js.map

package/dist/utils/is.js.map

@@ -1 +1 @@
-{"version":3,"file":"is.js","sourceRoot":"","sources":["../../src/utils/is.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAoC,EAAE,CAC3E,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,iBAAiB,CAAA;AAE7D,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,KAAc,EAAiB,EAAE,CACtD,OAAO,KAAK,KAAK,QAAQ,CAAA;AAE3B,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAc,EAAiB,EAAE,CAC3D,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;AAEvC,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAA6B,EAAE,CAC7E,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAA;AAEvC,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAI,KAAQ,EAA2B,EAAE,CAC3E,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAA"}
+{"version":3,"file":"is.js","sourceRoot":"","sources":["../../src/utils/is.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAoC,EAAE,CAC3E,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,iBAAiB,CAAA;AAE7D,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAmB,EAAE,CAC1D,OAAO,KAAK,KAAK,QAAQ,CAAA;AAE3B,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,KAAc,EAAiB,EAAE,CACtD,OAAO,KAAK,KAAK,QAAQ,CAAA;AAE3B,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAc,EAAiB,EAAE,CAC3D,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;AAEvC,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAA6B,EAAE,CAC7E,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAA;AAEvC,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAI,KAAQ,EAA2B,EAAE,CAC3E,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAA;AAE3B,MAAM,CAAC,MAAM,eAAe,GAAG,CAAI,KAAc,EAAgB,EAAE,CACjE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "map-transform",
-  "version": "1.2.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"
   }