Handle no buckets and export bucket transformer

Author: kjellmorten

src/transformers/bucket.test.ts

@@ -2,7 +2,7 @@ import test from 'ava'
 import transform from '../operations/transform.js'
 import compare from './compare.js'
 
-import bucket from './bucket.js'
+import bucket, { Bucket } from './bucket.js'
 
 // Setup
 
@@ -214,6 +214,23 @@ test('should merge bucket arrays into one array when going forward and flipped',
   t.deepEqual(ret, expected)
 })
 
+test('should return an empty object when no buckets are defined', async (t) => {
+  const data = [
+    { id: 'user1', name: 'User 1', role: 'editor' },
+    { id: 'user2', name: 'User 2', role: undefined },
+    { id: 'user3', name: 'User 3' },
+    { id: 'user4', name: 'User 4', role: 'admin' },
+    { id: 'user5', name: 'User 5' },
+    { id: 'user6', name: 'User 6', role: 'editor' },
+  ]
+  const buckets: Bucket[] = []
+  const expected = {}
+
+  const ret = await bucket({ buckets })(options)(data, state)
+
+  t.deepEqual(ret, expected)
+})
+
 // Tests -- rev
 
 test('should merge bucket arrays into one array in the order of the defined buckets', async (t) => {
@@ -407,6 +424,27 @@ test('should return empty array when we have no buckets object', async (t) => {
   t.deepEqual(ret, expected)
 })
 
+test('should return empty array when no buckets are defined', async (t) => {
+  const data = {
+    users: [
+      { id: 'user2', name: 'User 2', role: undefined },
+      { id: 'user3', name: 'User 3' },
+      { id: 'user5', name: 'User 5' },
+    ],
+    admin: [{ id: 'user4', name: 'User 4', role: 'admin' }],
+    editor: [
+      { id: 'user1', name: 'User 1', role: 'editor' },
+      { id: 'user6', name: 'User 6', role: 'editor' },
+    ],
+  }
+  const buckets: Bucket[] = []
+  const expected: unknown[] = []
+
+  const ret = await bucket({ buckets })(options)(data, stateRev)
+
+  t.deepEqual(ret, expected)
+})
+
 test('should sort array into buckets in rev when flipped', async (t) => {
   const stateRevFlipped = { ...stateRev, flip: true }
   const data = [

src/transformers/bucket.ts

@@ -22,7 +22,7 @@ export interface Bucket {
 
 export interface Props extends TransformerProps {
   path?: Path
-  buckets: Bucket[]
+  buckets?: Bucket[]
 }
 
 function addToBucket(
@@ -74,7 +74,7 @@ const extractArrayFromBuckets = (
 
 const transformer: AsyncTransformer<Props> = function bucket({
   path = '.',
-  buckets,
+  buckets = [],
 }) {
   return (options) => {
     const getFn = pathGetter(path)

src/transformers/index.ts

@@ -1,4 +1,5 @@
 import { value, fixed } from './value.js'
+import bucket from './bucket.js'
 import compare from './compare.js'
 import { explode, implode } from './explode.js'
 import flatten from './flatten.js'
@@ -11,6 +12,7 @@ import not from './not.js'
 import sort from './sort.js'
 
 export default {
+  bucket,
   compare,
   explode,
   fixed,