@uipath/data-fabric-tool 0.9.1 → 1.0.4

package/src/commands/records.ts

@@ -15,6 +15,7 @@ import { createDataFabricClient } from "../utils/sdk-client";
 interface ListOptions {
     tenant?: string;
     limit: string;
+    offset?: string;
     cursor?: string;
 }
 
@@ -43,6 +44,7 @@ interface QueryOptions {
     file?: string;
     body?: string;
     limit: string;
+    offset?: string;
     cursor?: string;
 }
 
@@ -162,6 +164,10 @@ export const registerRecordsCommand = (program: Command) => {
             "Number of records to return per page",
             "50",
         )
+        .option(
+            "-o, --offset <number>",
+            "Start from the page containing this record index (rounded down to nearest page boundary; (mutually exclusive with --cursor)",
+        )
         .option(
             "--cursor <cursor>",
             "Pagination cursor from a previous response to fetch the next page",
@@ -170,7 +176,7 @@ export const registerRecordsCommand = (program: Command) => {
         .trackedAction(
             processContext,
             async (entityId: string, options: ListOptions) => {
-                const pageSize = parseInt(options.limit, 10);
+                const pageSize = Number(options.limit);
                 if (Number.isNaN(pageSize) || pageSize < 1) {
                     OutputFormatter.error({
                         Result: RESULTS.Failure,
@@ -181,6 +187,36 @@ export const registerRecordsCommand = (program: Command) => {
                     return;
                 }
 
+                if (
+                    options.cursor !== undefined &&
+                    options.offset !== undefined
+                ) {
+                    OutputFormatter.error({
+                        Result: RESULTS.Failure,
+                        Message: "--offset and --cursor are mutually exclusive",
+                        Instructions:
+                            "Use --offset to jump to a position by record count, or --cursor to continue from a previous response.",
+                    });
+                    processContext.exit(1);
+                    return;
+                }
+
+                let jumpToPage: number | undefined;
+                if (options.offset !== undefined) {
+                    const offsetValue = Number(options.offset);
+                    if (Number.isNaN(offsetValue) || offsetValue < 0) {
+                        OutputFormatter.error({
+                            Result: RESULTS.Failure,
+                            Message: "Invalid --offset value",
+                            Instructions:
+                                "Provide a non-negative integer for --offset.",
+                        });
+                        processContext.exit(1);
+                        return;
+                    }
+                    jumpToPage = Math.floor(offsetValue / pageSize) + 1;
+                }
+
                 const [clientError, sdk] = await catchError(
                     createDataFabricClient(options.tenant),
                 );
@@ -201,6 +237,7 @@ export const registerRecordsCommand = (program: Command) => {
                         ...(options.cursor !== undefined && {
                             cursor: { value: options.cursor },
                         }),
+                        ...(jumpToPage !== undefined && { jumpToPage }),
                     }),
                 );
 
@@ -552,25 +589,30 @@ export const registerRecordsCommand = (program: Command) => {
     records
         .command("query")
         .description(
-            "Query records in a Data Fabric entity with filters and sorting. " +
+            "Query records in a Data Fabric entity with filters, sorting, and aggregates. " +
                 "Provide a JSON object via --body or --file with optional keys: " +
-                "filterGroup, sortOptions (use isDescending: true/false), selectedFields.",
+                "filterGroup, sortOptions (use isDescending: true/false), selectedFields, " +
+                "aggregates (function: COUNT/SUM/AVG/MIN/MAX, field, alias?), groupBy.",
         )
         .argument("<id>", "Entity ID")
         .option("-t, --tenant <tenant-name>", "Tenant name")
         .option(
             "-f, --file <path>",
-            "Path to JSON file with query options (filterGroup, selectedFields, sortOptions)",
+            "Path to JSON file with query options (filterGroup, selectedFields, sortOptions, aggregates, groupBy)",
         )
         .option(
             "--body <json>",
-            "Inline JSON query options (filterGroup, selectedFields, sortOptions)",
+            "Inline JSON query options (filterGroup, selectedFields, sortOptions, aggregates, groupBy)",
         )
         .option(
             "-l, --limit <number>",
             "Number of records to return per page",
             "50",
         )
+        .option(
+            "-o, --offset <number>",
+            "Start from the page containing this record index (rounded down to nearest page boundary;(mutually exclusive with --cursor)",
+        )
         .option(
             "--cursor <cursor>",
             "Pagination cursor from a previous response to fetch the next page",
@@ -578,7 +620,7 @@ export const registerRecordsCommand = (program: Command) => {
         .trackedAction(
             processContext,
             async (entityId: string, options: QueryOptions) => {
-                const pageSize = parseInt(options.limit, 10);
+                const pageSize = Number(options.limit);
                 if (Number.isNaN(pageSize) || pageSize < 1) {
                     OutputFormatter.error({
                         Result: RESULTS.Failure,
@@ -589,6 +631,36 @@ export const registerRecordsCommand = (program: Command) => {
                     return;
                 }
 
+                if (
+                    options.cursor !== undefined &&
+                    options.offset !== undefined
+                ) {
+                    OutputFormatter.error({
+                        Result: RESULTS.Failure,
+                        Message: "--offset and --cursor are mutually exclusive",
+                        Instructions:
+                            "Use --offset to jump to a position by record count, or --cursor to continue from a previous response.",
+                    });
+                    processContext.exit(1);
+                    return;
+                }
+
+                let jumpToPage: number | undefined;
+                if (options.offset !== undefined) {
+                    const offsetValue = Number(options.offset);
+                    if (Number.isNaN(offsetValue) || offsetValue < 0) {
+                        OutputFormatter.error({
+                            Result: RESULTS.Failure,
+                            Message: "Invalid --offset value",
+                            Instructions:
+                                "Provide a non-negative integer for --offset.",
+                        });
+                        processContext.exit(1);
+                        return;
+                    }
+                    jumpToPage = Math.floor(offsetValue / pageSize) + 1;
+                }
+
                 let queryBody: Record<string, unknown> | null = null;
                 if (options.file !== undefined || options.body !== undefined) {
                     const [parseError, parsed] = await catchError(
@@ -616,7 +688,7 @@ export const registerRecordsCommand = (program: Command) => {
                             Result: RESULTS.Failure,
                             Message: "Query options must be a JSON object",
                             Instructions:
-                                "Provide a JSON object (not an array) with filterGroup, selectedFields, or sortOptions.",
+                                "Provide a JSON object (not an array) with filterGroup, selectedFields, sortOptions, aggregates, or groupBy.",
                         });
                         processContext.exit(1);
                         return;
@@ -645,6 +717,7 @@ export const registerRecordsCommand = (program: Command) => {
                         ...(options.cursor !== undefined && {
                             cursor: { value: options.cursor },
                         }),
+                        ...(jumpToPage !== undefined && { jumpToPage }),
                     }),
                 );