Implement MongoDB ODM support

Author: Boris Abramov

README.md

@@ -123,9 +123,9 @@ return new UserResource(users).omit('createdAt', 'updatedAt').get()
 
 get() finalizes data processing. While pick(), omit() and redefine() modify data, trailing get() or paginate() is needed to complete the response. This requirement is not applied to refine() and refinePaginate()
 
-## Lucid pagination support
+## Pagination support
 
-Lucid offset-based pagination is supported.
+Offset-based pagination is supported for [Lucid](https://github.com/adonisjs/lucid) and [MongoDB ODM for AdonisJS](https://github.com/DreamsHive/adonis-odm)
 
 [gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/manomintis/adonis-api-resources/test.yml?style=for-the-badge
 [gh-workflow-url]: https://github.com/manomintis/adonis-api-resources/actions/workflows/test.yml "Github action"

package.json

@@ -60,7 +60,7 @@
  "@adonisjs/tsconfig": "^1.2.1",
  "@japa/assert": "^2.1.0",
  "@japa/runner": "^3.1.1",
- "@swc/core": "^1.3.102",
+ "@swc/core": "^1.13.0",
  "@types/node": "^20.10.7",
  "c8": "^9.0.0",
  "copyfiles": "^2.4.1",

src/resource.ts

@@ -13,7 +13,11 @@ export abstract class Resource {
  abstract defineMap(data: any): object
 
  private isPaginated(): boolean {
- return 'rows' in this.data && 'currentPage' in this.data
+ const ormPaginated = 'rows' in this.data && 'currentPage' in this.data
+ const odmPaginated = 'data' in this.data && 'meta' in this.data
+ const indeedPaginated = ormPaginated || odmPaginated
+ if (odmPaginated) this.data.getMeta = () => this.data.meta
+ return indeedPaginated
  }
 
  private isCollection(): boolean {
@@ -68,7 +72,7 @@ export abstract class Resource {
  if (this.isPaginated()) {
  this.data = this.parsePaginated(
  (this.data as any).getMeta(),
- this.pickCollection((this.data as any).rows, keys)
+ this.pickCollection((this.data as any).rows || (this.data as any).data, keys)
  )
  } else if (this.isCollection()) {
  this.data = this.pickCollection(this.data, keys)
@@ -82,7 +86,7 @@ export abstract class Resource {
  if (this.isPaginated()) {
  this.data = this.parsePaginated(
  (this.data as any).getMeta(),
- this.omitCollection((this.data as any).rows, keys)
+ this.omitCollection((this.data as any).rows || (this.data as any).data, keys)
  )
  } else if (this.isCollection()) {
  this.data = this.omitCollection(this.data, keys)
@@ -96,7 +100,7 @@ export abstract class Resource {
  if (this.isPaginated()) {
  this.data = this.parsePaginated(
  (this.data as any).getMeta(),
- this.redefineCollection((this.data as any).rows)
+ this.redefineCollection((this.data as any).rows || (this.data as any).data)
  )
  } else if (this.isCollection()) {
  this.data = this.redefineCollection(this.data)
@@ -115,7 +119,7 @@ export abstract class Resource {
  }
 
  paginate(page: number = 1, limit: number = 10) {
- let lastPage = Math.max(Math.ceil(this.data.length / limit), 1)
+ const lastPage = Math.max(Math.ceil(this.data.data.length / limit), 1)
  interface PaginationMeta {
  total: number
  perPage: number
@@ -138,7 +142,7 @@ export abstract class Resource {
  nextPageUrl: page < lastPage ? `/?page=${page + 1}` : null,
  previousPageUrl: page > 1 ? `/?page=${page - 1}` : null,
  }
- const collection = this.data.slice((page - 1) * limit, page * limit)
+ const collection = (this.data.rows || this.data.data).slice((page - 1) * limit, page * limit)
  this.data = {
  meta: meta,
  data: collection,

tests/collection.spec.ts

@@ -0,0 +1,76 @@
+import { Resource } from '../src/resource.js'
+import { test } from '@japa/runner'
+
+class TestResourceResource extends Resource {
+ defineMap(data: any): object {
+ return {
+ fullName: data.firstName + ' ' + data.lastName,
+ firstName: data.firstName,
+ lastName: data.lastName,
+ }
+ }
+}
+
+const testObjectCollection = [
+ {
+ firstName: 'John',
+ lastName: 'Doe',
+ serialize: () => {
+ return {
+ firstName: 'John',
+ lastName: 'Doe',
+ }
+ },
+ },
+ {
+ firstName: 'Jane',
+ lastName: 'Doe',
+ },
+ {
+ firstName: 'John1',
+ lastName: 'Doe1',
+ },
+ {
+ firstName: 'Jane1',
+ lastName: 'Doe1',
+ },
+ {
+ firstName: 'John2',
+ lastName: 'Doe2',
+ },
+ {
+ firstName: 'Jane2',
+ lastName: 'Doe2',
+ },
+ {
+ firstName: 'John3',
+ lastName: 'Doe3',
+ },
+ {
+ firstName: 'Jane3',
+ lastName: 'Doe3',
+ },
+]
+
+const resultRefineCollection: any = new TestResourceResource(testObjectCollection).refine()
+const resultPickCollection: any = new TestResourceResource(testObjectCollection)
+ .pick('firstName')
+ .get()
+const resultOmitCollection: any = new TestResourceResource(testObjectCollection)
+ .omit('firstName')
+ .get()
+
+test.group('Collection', () => {
+ test('test_collection', ({ assert }) => {
+ assert.equal(resultRefineCollection[0].fullName, 'John Doe')
+ assert.equal(resultRefineCollection[1].fullName, 'Jane Doe')
+ })
+ test('test_pick_collection', ({ assert }) => {
+ assert.equal(resultPickCollection[0].firstName, 'John')
+ assert.equal(resultPickCollection[0].lastName, undefined)
+ })
+ test('test_omit_collection', ({ assert }) => {
+ assert.equal(resultOmitCollection[0].firstName, undefined)
+ assert.equal(resultOmitCollection[0].lastName, 'Doe')
+ })
+})

tests/entity.spec.ts

@@ -0,0 +1,35 @@
+import { Resource } from '../src/resource.js'
+import { test } from '@japa/runner'
+
+class TestResourceResource extends Resource {
+ defineMap(data: any): object {
+ return {
+ fullName: data.firstName + ' ' + data.lastName,
+ firstName: data.firstName,
+ lastName: data.lastName,
+ }
+ }
+}
+
+const testObjectEntity = {
+ firstName: 'John',
+ lastName: 'Doe',
+}
+
+const resultRefineEntity: any = new TestResourceResource(testObjectEntity).refine()
+const resultPickEntity: any = new TestResourceResource(testObjectEntity).pick('firstName').get()
+const resultOmitEntity: any = new TestResourceResource(testObjectEntity).omit('firstName').get()
+
+test.group('Entity', () => {
+ test('test_entity', ({ assert }) => {
+ assert.equal(resultRefineEntity.fullName, 'John Doe')
+ })
+ test('test_pick_entity', ({ assert }) => {
+ assert.equal(resultPickEntity.firstName, 'John')
+ assert.equal(resultPickEntity.lastName, undefined)
+ })
+ test('test_omit_entity', ({ assert }) => {
+ assert.equal(resultOmitEntity.firstName, undefined)
+ assert.equal(resultOmitEntity.lastName, 'Doe')
+ })
+})

tests/odmpaginated.spec.ts

@@ -0,0 +1,106 @@
+import { Resource } from '../src/resource.js'
+import { test } from '@japa/runner'
+
+class TestResourceResource extends Resource {
+ defineMap(data: any): object {
+ return {
+ fullName: data.firstName + ' ' + data.lastName,
+ firstName: data.firstName,
+ lastName: data.lastName,
+ }
+ }
+}
+
+const testObjectCollection = [
+ {
+ firstName: 'John',
+ lastName: 'Doe',
+ serialize: () => {
+ return {
+ firstName: 'John',
+ lastName: 'Doe',
+ }
+ },
+ },
+ {
+ firstName: 'Jane',
+ lastName: 'Doe',
+ },
+ {
+ firstName: 'John1',
+ lastName: 'Doe1',
+ },
+ {
+ firstName: 'Jane1',
+ lastName: 'Doe1',
+ },
+ {
+ firstName: 'John2',
+ lastName: 'Doe2',
+ },
+ {
+ firstName: 'Jane2',
+ lastName: 'Doe2',
+ },
+ {
+ firstName: 'John3',
+ lastName: 'Doe3',
+ },
+ {
+ firstName: 'Jane3',
+ lastName: 'Doe3',
+ },
+]
+
+class ObjectPaginated {
+ data = testObjectCollection
+ meta = { currentPage: 1 }
+}
+
+const testObjectPaginated = new ObjectPaginated()
+
+const resultRefineODMPaginated: any = new TestResourceResource(testObjectPaginated).refine()
+const resultRefinedPaginated: any = new TestResourceResource(testObjectPaginated).refinePaginate(
+ 1,
+ 4
+)
+const resultRefinedPaginated2: any = new TestResourceResource(testObjectPaginated).refinePaginate(
+ 2,
+ 4
+)
+
+const resultPickPaginated: any = new TestResourceResource(testObjectPaginated)
+ .pick('firstName')
+ .get()
+
+const resultOmitPaginated: any = new TestResourceResource(testObjectPaginated)
+ .omit('firstName')
+ .get()
+
+test.group('ODM paginated', () => {
+ test('test_pagination', ({ assert }) => {
+ assert.equal(resultRefineODMPaginated.data[0].fullName, 'John Doe')
+ assert.equal(resultRefineODMPaginated.data[1].fullName, 'Jane Doe')
+ assert.equal(resultRefineODMPaginated.meta.currentPage, 1)
+ })
+ test('test_refine_pagination', ({ assert }) => {
+ assert.equal(resultRefinedPaginated.data[0].fullName, 'John Doe')
+ assert.equal(resultRefinedPaginated.data[1].fullName, 'Jane Doe')
+ assert.equal(resultRefinedPaginated.meta.currentPage, 1)
+ })
+ test('test_refine_pagination2', ({ assert }) => {
+ assert.equal(resultRefinedPaginated2.data[0].fullName, 'John2 Doe2')
+ assert.equal(resultRefinedPaginated2.data[1].fullName, 'Jane2 Doe2')
+ assert.equal(resultRefinedPaginated2.meta.currentPage, 2)
+ })
+ test('test_pick_collection_paginated', ({ assert }) => {
+ assert.equal(resultPickPaginated.data[0].firstName, 'John')
+ assert.equal(resultPickPaginated.data[0].lastName, undefined)
+ assert.equal(resultPickPaginated.meta.currentPage, 1)
+ })
+ test('test_pick_collection_paginated', ({ assert }) => {
+ assert.equal(resultOmitPaginated.data[0].firstName, undefined)
+ assert.equal(resultOmitPaginated.data[0].lastName, 'Doe')
+ assert.equal(resultOmitPaginated.meta.currentPage, 1)
+ })
+})

tests/resource.spec.ts renamed to tests/ormpaginated.spec.ts

@@ -11,11 +11,6 @@ class TestResourceResource extends Resource {
  }
 }
 
-const testObjectEntity = {
- firstName: 'John',
- lastName: 'Doe',
-}
-
 const testObjectCollection = [
  {
  firstName: 'John',
@@ -64,48 +59,32 @@ class ObjectPaginated {
  return { currentPage: 1 }
  }
 }
+
 const testObjectPaginated = new ObjectPaginated()
 
-const resultRefineEntity: any = new TestResourceResource(testObjectEntity).refine()
-const resultRefineCollection: any = new TestResourceResource(testObjectCollection).refine()
-const resultRefineLucidPaginated: any = new TestResourceResource(testObjectPaginated).refine()
-const resultRefinedPaginated: any = new TestResourceResource(testObjectCollection).refinePaginate(
+const resultRefineORMPaginated: any = new TestResourceResource(testObjectPaginated).refine()
+const resultRefinedPaginated: any = new TestResourceResource(testObjectPaginated).refinePaginate(
  1,
  4
 )
-const resultRefinedPaginated2: any = new TestResourceResource(testObjectCollection).refinePaginate(
+const resultRefinedPaginated2: any = new TestResourceResource(testObjectPaginated).refinePaginate(
  2,
  4
 )
 
-const resultPickEntity: any = new TestResourceResource(testObjectEntity).pick('firstName').get()
-const resultPickCollection: any = new TestResourceResource(testObjectCollection)
- .pick('firstName')
- .get()
 const resultPickPaginated: any = new TestResourceResource(testObjectPaginated)
  .pick('firstName')
  .get()
 
-const resultOmitEntity: any = new TestResourceResource(testObjectEntity).omit('firstName').get()
-const resultOmitCollection: any = new TestResourceResource(testObjectCollection)
- .omit('firstName')
- .get()
 const resultOmitPaginated: any = new TestResourceResource(testObjectPaginated)
  .omit('firstName')
  .get()
 
-test.group('Resource', () => {
- test('test_entity', ({ assert }) => {
- assert.equal(resultRefineEntity.fullName, 'John Doe')
- })
- test('test_collection', ({ assert }) => {
- assert.equal(resultRefineCollection[0].fullName, 'John Doe')
- assert.equal(resultRefineCollection[1].fullName, 'Jane Doe')
- })
+test.group('ORM paginated', () => {
  test('test_pagination', ({ assert }) => {
- assert.equal(resultRefineLucidPaginated.data[0].fullName, 'John Doe')
- assert.equal(resultRefineLucidPaginated.data[1].fullName, 'Jane Doe')
- assert.equal(resultRefineLucidPaginated.meta.currentPage, 1)
+ assert.equal(resultRefineORMPaginated.data[0].fullName, 'John Doe')
+ assert.equal(resultRefineORMPaginated.data[1].fullName, 'Jane Doe')
+ assert.equal(resultRefineORMPaginated.meta.currentPage, 1)
  })
  test('test_refine_pagination', ({ assert }) => {
  assert.equal(resultRefinedPaginated.data[0].fullName, 'John Doe')
@@ -117,29 +96,11 @@ test.group('Resource', () => {
  assert.equal(resultRefinedPaginated2.data[1].fullName, 'Jane2 Doe2')
  assert.equal(resultRefinedPaginated2.meta.currentPage, 2)
  })
-
- test('test_pick_entity', ({ assert }) => {
- assert.equal(resultPickEntity.firstName, 'John')
- assert.equal(resultPickEntity.lastName, undefined)
- })
- test('test_pick_collection', ({ assert }) => {
- assert.equal(resultPickCollection[0].firstName, 'John')
- assert.equal(resultPickCollection[0].lastName, undefined)
- })
  test('test_pick_collection_paginated', ({ assert }) => {
  assert.equal(resultPickPaginated.data[0].firstName, 'John')
  assert.equal(resultPickPaginated.data[0].lastName, undefined)
  assert.equal(resultPickPaginated.meta.currentPage, 1)
  })
-
- test('test_omit_entity', ({ assert }) => {
- assert.equal(resultOmitEntity.firstName, undefined)
- assert.equal(resultOmitEntity.lastName, 'Doe')
- })
- test('test_omit_collection', ({ assert }) => {
- assert.equal(resultOmitCollection[0].firstName, undefined)
- assert.equal(resultOmitCollection[0].lastName, 'Doe')
- })
  test('test_pick_collection_paginated', ({ assert }) => {
  assert.equal(resultOmitPaginated.data[0].firstName, undefined)
  assert.equal(resultOmitPaginated.data[0].lastName, 'Doe')