Refactor pagination and update data handling in remote components

luancazarine · luancazarine · commit a11fc1300f2f · 2025-12-10T20:11:53.000-03:00
- Added a dataKey parameter to the paginate function for flexible data extraction.
- Updated references in list-employments and other components to utilize the new dataKey.
- Corrected employment ID references in new contract amendment and onboarding sources.
- Improved descriptions in custom field value updated source for clarity.
diff --git a/components/remote/actions/list-employments/list-employments.mjs b/components/remote/actions/list-employments/list-employments.mjs
@@ -8,7 +8,7 @@ export default {
   annotations: {
     destructiveHint: false,
     openWorldHint: true,
-    readOnlyHint: false,
+    readOnlyHint: true,
   },
   type: "action",
   props: {
@@ -51,6 +51,7 @@ export default {
   async run({ $ }) {
     const response = this.remote.paginate({
       $,
+      dataKey: "employments",
       fn: this.remote.listEmployments,
       params: {
         email: this.email,
diff --git a/components/remote/actions/show-timeoff-balance/show-timeoff-balance.mjs b/components/remote/actions/show-timeoff-balance/show-timeoff-balance.mjs
@@ -8,7 +8,7 @@ export default {
   annotations: {
     destructiveHint: false,
     openWorldHint: true,
-    readOnlyHint: false,
+    readOnlyHint: true,
   },
   type: "action",
   props: {
diff --git a/components/remote/remote.app.mjs b/components/remote/remote.app.mjs
@@ -104,7 +104,7 @@ export default {
       });
     },
     async *paginate({
-      fn, params = {}, maxResults = null, ...args
+      fn, params = {}, dataKey = "data", maxResults = null, ...args
     }) {
       let hasMore = false;
       let count = 0;
@@ -114,7 +114,7 @@ export default {
         params.page = ++page;
         const {
           data: {
-            employments,
+            [dataKey]: data,
             current_page,
             total_pages,
           },
@@ -123,7 +123,7 @@ export default {
           ...args,
         });
 
-        for (const d of employments) {
+        for (const d of data) {
           yield d;
 
           if (maxResults && ++count === maxResults) {
diff --git a/components/remote/sources/new-contract-amendment-done-instant/new-contract-amendment-done-instant.mjs b/components/remote/sources/new-contract-amendment-done-instant/new-contract-amendment-done-instant.mjs
@@ -21,8 +21,8 @@ export default {
       ts,
     }) {
       return {
-        id: body.employment_id,
-        summary: `Contract amendment for employment with ID ${body.employment_id} has been done`,
+        id: body.employment_request_id,
+        summary: `Contract amendment for employment with ID ${body.employment_request_id} has been done`,
         ts,
       };
     },
diff --git a/components/remote/sources/new-custom-field-value-updated-instant/new-custom-field-value-updated-instant.mjs b/components/remote/sources/new-custom-field-value-updated-instant/new-custom-field-value-updated-instant.mjs
@@ -5,7 +5,7 @@ export default {
   ...common,
   key: "remote-new-custom-field-value-updated-instant",
   name: "New Custom Field Value Updated (Instant)",
-  description: "Emit new event when a custom field is updated. [See the documentation](https://developer.remote.com/reference/customfieldupdated)",
+  description: "Emit new event when a custom field is updated. [See the documentation](https://developer.remote.com/reference/custom_fieldvalue_updated)",
   version: "0.0.1",
   type: "source",
   dedupe: "unique",
diff --git a/components/remote/sources/new-employment-onboarding-started-instant/new-employment-onboarding-started-instant.mjs b/components/remote/sources/new-employment-onboarding-started-instant/new-employment-onboarding-started-instant.mjs
@@ -5,7 +5,7 @@ export default {
   ...common,
   key: "remote-new-employment-onboarding-started-instant",
   name: "New Employment Onboarding Started (Instant)",
-  description: "Emit new event when a employment onboarding is started. [See the documentation](https://developer.remote.com/reference/employmentonboardingstarted)",
+  description: "Emit new event when an employment onboarding is started. [See the documentation](https://developer.remote.com/reference/employmentonboardingstarted)",
   version: "0.0.1",
   type: "source",
   dedupe: "unique",
