feat: add more methods to collection

Author: jlenon7

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@secjs/utils",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Utils functions and classes for Node.js",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",

src/Helpers/Collection.js

@@ -1,6 +1,18 @@
 import { Collection as CollectJS } from 'collect.js'
 
 export class Collection extends CollectJS {
+  /**
+   * An alias for macro instance method:
+   *
+   * @example
+   *  new Collection().macro()
+   *  @param {string} name
+   *  @param {Function} fn
+   */
+  static macro(name, fn) {
+    return new Collection().macro(name, fn)
+  }
+
   /**
    * Remove all duplicated values from the array.
    *
@@ -9,6 +21,26 @@ export class Collection extends CollectJS {
   removeDuplicated() {
     return [...new Set(this.all())]
   }
+
+  /**
+   * Execute the toResource method inside objects if exists.
+   *
+   * @param {any} [criterias]
+   * @return {any[]}
+   */
+  toResource(criterias = {}) {
+    return this.all().map(item => item.toResource(criterias))
+  }
+}
+
+// eslint-disable-next-line no-extend-native
+Array.prototype.toResource = function (criterias = {}) {
+  return this.map(model => model.toResource(criterias))
+}
+
+// eslint-disable-next-line no-extend-native
+Array.prototype.toCollection = function () {
+  return new Collection(this)
 }
 
 Collection.prototype.order = Collection.prototype.sort

src/index.d.ts

@@ -124,13 +124,32 @@ export declare class Clean {
 }
 
 export declare class Collection<Item = any> extends CollectJS<Item> {
+  /**
+   * An alias for macro instance method:
+   *
+   * @example
+   *  new Collection().macro()
+   *
+   *  @param {string} name
+   *  @param {Function} fn
+   */
+  static macro(name: string, fn: Function): void
+
   /**
    * Remove all duplicated values from the array.
    *
    * @return {any[]}
    */
   removeDuplicated(): Item[]
 
+  /**
+   * Execute the toResource method inside objects if exists.
+   *
+   * @param {any} [criterias]
+   * @return {any[]}
+   */
+  toResource(criterias?: any): any[]
+
   /**
    * The sortDesc method sort the collection in descending mode.
    */
@@ -1938,3 +1957,11 @@ export declare class Uuid {
    */
   static changeOrGenerate(prefix: string, token?: string): string
 }
+
+declare global {
+  interface Array<T> {
+    toResource(criterias?: any): T[];
+
+    toCollection(): Collection<T>;
+  }
+}

tests/Unit/CollectionTest.js

@@ -16,4 +16,23 @@ test.group('CollectionTest', () => {
 
     assert.deepEqual(collection.removeDuplicated(), [1, 2, 3, 4, 5])
   })
+
+  test('should be able to extend collections by static macro method', async ({ assert }) => {
+    Collection.macro('test', () => ({ hello: 'world' }))
+
+    assert.deepEqual(new Collection().test(), { hello: 'world' })
+  })
+
+  test('should be able to execute the toResource method inside objects of collections', async ({ assert }) => {
+    const models = [
+      {
+        toResource: () => ({ id: 1 }),
+      },
+      { toResource: criterias => criterias },
+    ]
+
+    assert.deepEqual(models.toResource({ id: 2 }), [{ id: 1 }, { id: 2 }])
+    assert.deepEqual(models.toCollection().toResource({ id: 2 }), [{ id: 1 }, { id: 2 }])
+    assert.deepEqual(new Collection(models).toResource({ id: 2 }), [{ id: 1 }, { id: 2 }])
+  })
 })