Introduce offset-based pagination support

README.md

@@ -98,6 +98,18 @@ Array of models:
 ]
 ```
 
+
+## Pagination support
+
+
+Offset-based pagination is supported. Example usage:
+
+```typescript
+const users = await User.query().paginate(1, 10)
+return new UserResource(users).refine()
+```
+
+
 [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"
 

src/resource.ts

@@ -32,10 +32,17 @@ export abstract class Resource {
 
   // Return refined output
   refine(): object {
-    if (!Array.isArray(this.data)) {
-      return this.refine_entity(this.data)
-    } else {
+    if ('rows' in this.data && 'currentPage' in this.data) {
+      const meta = (this.data as any).getMeta()
+      const collection = this.refine_collection((this.data as any).rows)
+      const result = {
+        meta: meta,
+        data: collection,
+      }
+      return result
+    } else if (Array.isArray(this.data)) {
       return this.refine_collection(this.data)
     }
+    return this.refine_entity(this.data)
   }
 }

tests/resource.spec.ts

@@ -9,15 +9,55 @@ class TestResourceResource extends Resource {
   }
 }
 
-const testObject = {
+const testObjectEntity = {
   firstName: 'John',
   lastName: 'Doe',
 }
 
-const result: any = new TestResourceResource(testObject).refine()
+const testObjectCollection = [
+  {
+    firstName: 'John',
+    lastName: 'Doe',
+  },
+  {
+    firstName: 'Jane',
+    lastName: 'Doe',
+  },
+]
+
+class ObjectPaginated {
+  currentPage = 1
+  rows = [
+    {
+      firstName: 'John',
+      lastName: 'Doe',
+    },
+    {
+      firstName: 'Jane',
+      lastName: 'Doe',
+    },
+  ]
+  getMeta() {
+    return { currentPage: 1 }
+  }
+}
+const testObjectPaginated = new ObjectPaginated()
+
+const resultEntity: any = new TestResourceResource(testObjectEntity).refine()
+const resultCollection: any = new TestResourceResource(testObjectCollection).refine()
+const resultPaginated: any = new TestResourceResource(testObjectPaginated).refine()
 
 test.group('Resource', () => {
-  test('create full name', ({ assert }) => {
-    assert.equal(result.fullName, 'John Doe')
+  test('test_entity', ({ assert }) => {
+    assert.equal(resultEntity.fullName, 'John Doe')
+  })
+  test('test_collection', ({ assert }) => {
+    assert.equal(resultCollection[0].fullName, 'John Doe')
+    assert.equal(resultCollection[1].fullName, 'Jane Doe')
+  })
+  test('test_pagination', ({ assert }) => {
+    assert.equal(resultPaginated.data[0].fullName, 'John Doe')
+    assert.equal(resultPaginated.data[1].fullName, 'Jane Doe')
+    assert.equal(resultPaginated.meta.currentPage, 1)
   })
 })