@skedulo/pulse-solution-services 0.0.14 → 0.0.16

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [v0.0.16] - 2025-06-19
+### Added
+- Support upsert mutation.
+- Support batch queries and mutations.
+
+## [v0.0.15] - 2025-05-21
+### Updated
+- Enable GraphQLRequest with variable to graphqlClient
+
 ## [v0.0.14] - 2025-05-21
 ### Added
 - Add graphql mutation option to suppress change events.

package/README.md

@@ -103,7 +103,7 @@ const artifactClient = context.newArtifactClient(ArtifactType.WEBHOOK);
 const webhooks = await artifactClient.list();
 const functionPromises = webhooks.map((webhook: any) => artifactClient.get(webhook.name));
 await Promise.all(functionPromises);
-// Get execution metric
+// Get execution metrics
 console.log(context.getExecutionMetrics());
 ```
 
@@ -187,7 +187,15 @@ const updatedVocabularyItem = await context.vocabularyClient.updateVocabularyIte
 #### GraphQL Client
 Executes GraphQL queries and mutations against `/graphql/graphql`.
 ```javascript
+// execute final query string
 const queryResult = await context.graphqlClient.execute(queryString, {readOnly: true});
+
+// using query string with variables
+const graphQLRequest: GraphQLRequest = {
+  query: queryString,
+  variables: {}
+}
+const queryUsingVariablesResult = await context.graphqlClient.execute(graphQLRequest, {readOnly: true});
 ```
 
 #### Config Variable Client
@@ -523,6 +531,58 @@ console.log(queryResult.endOffset); // 1
 
 The `X-Graphql-Operation` header is added to all GraphQL requests and contains the value of `operationName`.
 
+#### Query by Pages
+```javascript
+// Create a query builder for the Jobs object
+const queryBuilder = context.newQueryBuilder({
+  objectName: 'Jobs',
+  operationName: 'fetchJobs', 
+  readOnly: true
+});
+// Fetch data from pages 1 through 5 (inclusive)
+const queryResult = await queryBuilder.executeAll(1, 5);
+
+// Fetch data from the first 20 pages
+const queryResult = await queryBuilder.executeAll();
+```
+
+The `queryBuilder.executeAll` method supports querying up to a maximum of 20 pages.
+
+#### Batch Queries
+
+To execute multiple queries in a single request, use `graphqlService.queryBatch`. This method takes an array of query builders, sends them to the GraphQL batch endpoint, and returns an array of query results. This is useful for fetching data from multiple objects efficiently.
+
+```javascript
+// Create query builders for Jobs and Contacts
+const jobQueryBuilder = context.newQueryBuilder({
+  objectName: 'Jobs',
+  operationName: 'fetchJobs',
+  readOnly: true
+});
+jobQueryBuilder.withFields(['UID', 'Name'])
+               .withFilter('IsActive == true')
+               .withLimit(10);
+
+const contactQueryBuilder = context.newQueryBuilder({
+  objectName: 'Contacts',
+  operationName: 'fetchContacts',
+  readOnly: true
+});
+contactQueryBuilder.withFields(['UID', 'FirstName', 'LastName'])
+                   .withFilter('LastName != null')
+                   .withLimit(5);
+
+// Execute batch query
+const queryResults = await context.graphqlService.queryBatch([jobQueryBuilder, contactQueryBuilder]);
+
+// Process results
+const jobResults = queryResults[0];
+const contactResults = queryResults[1];
+console.log('Jobs:', jobResults.records);
+console.log('Job Total Count:', jobResults.totalCount);
+console.log('Contacts:', contactResults.records);
+console.log('Contact Total Count:', contactResults.totalCount);
+```
 #### Update data
 ```javascript
 const recordsToUpdate = queryResult.records.map((record) => {
@@ -531,27 +591,76 @@ const recordsToUpdate = queryResult.records.map((record) => {
     Name: record.Name + " - Updated"
   }
 });
-const updateResult = await context.graphqlService.mutate({
+const updateResult = await context.graphqlService.update({
     objectName: 'Resources',
-    operation: GraphqlOperations.UPDATE,
     operationName: 'updateResources',
     records: recordsToUpdate,
-    bulkOperation: true // optional
+    bulkOperation: true, // optional
     suppressChangeEvents: true // optional
   });
 ```
 
+#### upsert data
+```javascript
+const upsertResult = await context.graphqlService.upsert({
+    objectName: 'Resources',
+    operationName: 'updateResources',
+    records: recordsToUpsert,
+    bulkOperation: true, // optional
+    suppressChangeEvents: true, // optional
+    keyField: "ExternalId"
+  });
+```
+
+#### Batch mutations
+```javascript
+// Define mutation parameters for inserting Jobs and deleting Contacts
+const insertJobParams = {
+  objectName: 'Jobs',
+  operationName: 'insertJobs',
+  operation: GraphqlOperations.INSERT,
+  records: [
+    { UID: 'job1', Name: 'Developer Job', Status: 'Open' },
+    { UID: 'job2', Name: 'Designer Job', Status: 'Open' }
+  ],
+  bulkOperation: true
+};
+
+const deleteContactParams = {
+  objectName: 'Contacts',
+  operationName: 'deleteContacts',
+  operation: GraphqlOperations.DELETE,
+  records: [
+    { UID: 'contact1' },
+    { UID: 'contact2' }
+  ]
+};
+
+// Execute batch mutation
+const mutationResults = await context.graphqlService.mutateBatch([insertJobParams, deleteContactParams]);
+
+// Process results
+const insertResult = mutationResults[0];
+const deleteResult = mutationResults[1];
+console.log('Inserted Job UIDs:', context.graphqlService.extractUIDs(insertResult));
+console.log('Deleted Contact UIDs:', context.graphqlService.extractUIDs(deleteResult));
+```
+
 The `bulkOperation` and `readOnly` options help optimize large-scale mutations and read-heavy queries. When enabled, they automatically add the `X-Skedulo-Bulk-Operation` (for mutations) and `X-Skedulo-Read-Only` (for queries) headers to improve performance.
 To reduce the impact on change event processing, especially during high-volume mutations, the `suppressChangeEvents` option can be used. This disables change history tracking, helping to minimize delays.
 
-#### Pagination with offset
+#### Pagination
+
+The GraphQL Service supports pagination using either offset-based or cursor-based strategies, allowing you to fetch large datasets incrementally.
+
+*Pagination with offset*
 ```javascript
 while(queryResult.pageInfo.hasNextPage) {
   queryBuilder.withOffset(queryResult.endOffset + 1);
   queryResult = await queryBuilder.execute();
 }
 ```
-#### Pagination with cursor
+*Pagination with cursor*
 ```javascript
 while(queryResult.pageInfo.hasNextPage) {
   queryBuilder.withCursor(queryResult.endCursor);

package/dist/clients/graphql-client.js

@@ -1 +1 @@
-"use strict";var __decorate=this&&this.__decorate||function(t,e,r,n){var a,o=arguments.length,i=o<3?e:null===n?n=Object.getOwnPropertyDescriptor(e,r):n;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)i=Reflect.decorate(t,e,r,n);else for(var c=t.length-1;c>=0;c--)(a=t[c])&&(i=(o<3?a(i):o>3?a(e,r,i):a(e,r))||i);return o>3&&i&&Object.defineProperty(e,r,i),i},__metadata=this&&this.__metadata||function(t,e){if("object"==typeof Reflect&&"function"==typeof Reflect.metadata)return Reflect.metadata(t,e)},__awaiter=this&&this.__awaiter||function(t,e,r,n){return new(r||(r=Promise))((function(a,o){function i(t){try{s(n.next(t))}catch(t){o(t)}}function c(t){try{s(n.throw(t))}catch(t){o(t)}}function s(t){var e;t.done?a(t.value):(e=t.value,e instanceof r?e:new r((function(t){t(e)}))).then(i,c)}s((n=n.apply(t,e||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.GraphQLClient=void 0;const constants_1=require("../constants"),http_1=require("../constants/http"),monitor_call_1=require("../monitoring/decorators/monitor-call"),base_client_1=require("./base-client");class GraphQLClient extends base_client_1.BaseClient{execute(t){return __awaiter(this,arguments,void 0,(function*(t,e={}){return yield this._performRequest({method:http_1.HttpMethod.POST,endpoint:constants_1.TENANT_ENDPOINTS.GRAPHQL.SINGLE,body:{query:t},headers:e})}))}executeBatch(t){return __awaiter(this,arguments,void 0,(function*(t,e={}){return yield this._performRequest({method:http_1.HttpMethod.POST,endpoint:constants_1.TENANT_ENDPOINTS.GRAPHQL.BATCH,body:{query:t},headers:e})}))}handleResponseData(t){if(!t.data&&t.errors)throw new Error(`GraphQL error: ${JSON.stringify(t.errors)}`)}}exports.GraphQLClient=GraphQLClient,__decorate([(0,monitor_call_1.MonitorCall)(),__metadata("design:type",Function),__metadata("design:paramtypes",[String,Object]),__metadata("design:returntype",Promise)],GraphQLClient.prototype,"execute",null),__decorate([(0,monitor_call_1.MonitorCall)(),__metadata("design:type",Function),__metadata("design:paramtypes",[String,Object]),__metadata("design:returntype",Promise)],GraphQLClient.prototype,"executeBatch",null);
+"use strict";var __decorate=this&&this.__decorate||function(e,t,r,a){var n,o=arguments.length,i=o<3?t:null===a?a=Object.getOwnPropertyDescriptor(t,r):a;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)i=Reflect.decorate(e,t,r,a);else for(var s=e.length-1;s>=0;s--)(n=e[s])&&(i=(o<3?n(i):o>3?n(t,r,i):n(t,r))||i);return o>3&&i&&Object.defineProperty(t,r,i),i},__metadata=this&&this.__metadata||function(e,t){if("object"==typeof Reflect&&"function"==typeof Reflect.metadata)return Reflect.metadata(e,t)},__awaiter=this&&this.__awaiter||function(e,t,r,a){return new(r||(r=Promise))((function(n,o){function i(e){try{c(a.next(e))}catch(e){o(e)}}function s(e){try{c(a.throw(e))}catch(e){o(e)}}function c(e){var t;e.done?n(e.value):(t=e.value,t instanceof r?t:new r((function(e){e(t)}))).then(i,s)}c((a=a.apply(e,t||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.GraphQLClient=void 0;const constants_1=require("../constants"),http_1=require("../constants/http"),monitor_call_1=require("../monitoring/decorators/monitor-call"),base_client_1=require("./base-client");class GraphQLClient extends base_client_1.BaseClient{execute(e){return __awaiter(this,arguments,void 0,(function*(e,t={}){return yield this._performRequest({method:http_1.HttpMethod.POST,endpoint:constants_1.TENANT_ENDPOINTS.GRAPHQL.SINGLE,body:"string"==typeof e?{query:e}:{query:e.query,variables:e.variables},headers:t})}))}executeBatch(e){return __awaiter(this,arguments,void 0,(function*(e,t={}){const r=e.map((e=>"string"==typeof e?{query:e}:{query:e.query,variables:e.variables})),a=yield this._performRequest({method:http_1.HttpMethod.POST,endpoint:constants_1.TENANT_ENDPOINTS.GRAPHQL.BATCH,body:r,headers:t});return a.forEach(((e,t)=>{if(!e.data&&e.errors)throw new Error(`GraphQL batch error at index ${t}: ${JSON.stringify(e.errors)}`)})),a}))}handleResponseData(e){if(Array.isArray(e));else if(!e.data&&e.errors)throw new Error(`GraphQL error: ${JSON.stringify(e.errors)}`)}}exports.GraphQLClient=GraphQLClient,__decorate([(0,monitor_call_1.MonitorCall)(),__metadata("design:type",Function),__metadata("design:paramtypes",[Object,Object]),__metadata("design:returntype",Promise)],GraphQLClient.prototype,"execute",null),__decorate([(0,monitor_call_1.MonitorCall)(),__metadata("design:type",Function),__metadata("design:paramtypes",[Array,Object]),__metadata("design:returntype",Promise)],GraphQLClient.prototype,"executeBatch",null);

package/dist/index.d.ts

@@ -567,11 +567,12 @@ export interface GraphqlParams {
 	objectName: string;
 	operationName: string;
 }
-export interface GraphqlMurationParams extends GraphqlParams {
+export interface GraphqlMutationParams extends GraphqlParams {
 	records: HasId[];
-	operation: GraphqlOperations;
+	operation?: GraphqlOperations;
 	bulkOperation?: boolean;
 	suppressChangeEvents?: boolean;
+	keyField?: string;
 }
 export interface GraphqlQueryParams extends GraphqlParams {
 	first?: number;
@@ -596,27 +597,31 @@ export interface MutationResult {
 		};
 	};
 }
+export interface GraphQLRequest {
+	query: string;
+	variables: object;
+}
 /**
  * A client for executing GraphQL queries and mutations.
  * Extends the BaseClient to interact with the GraphQL API.
  */
 export declare class GraphQLClient extends BaseClient {
 	/**
-	 * Executes a GraphQL query or mutation.
-	 * @param {string} graphqlQuery - The GraphQL query or mutation string.
+	 * Executes a single GraphQL query or mutation.
+	 * @param {string | GraphQLRequest} graphqlQuery - The GraphQL query or mutation string.
 	 * @param {Record<string, string>} headers - Additional headers to include in the request.
 	 * @returns {Promise<GraphQlResponse>} - The response from the GraphQL API.
 	 * @throws {Error} - If the request fails or if there are errors in the response.
 	 */
-	execute(graphqlQuery: string, headers?: Record<string, string>): Promise<GraphQlResponse>;
+	execute(graphqlQuery: string | GraphQLRequest, headers?: Record<string, string>): Promise<GraphQlResponse>;
 	/**
-	 * Executes a GraphQL query or mutation.
-	 * @param {string} graphqlQuery - The GraphQL queries and/or mutations.
+	 * Executes a batch of GraphQL queries or mutations.
+	 * @param {Array<string | GraphQLRequest>} graphqlQueries - An array of GraphQL queries or mutations.
 	 * @param {Record<string, string>} headers - Additional headers to include in the request.
-	 * @returns {Promise<GraphQlResponse>} - The response from the GraphQL API.
-	 * @throws {Error} - If the request fails or if there are errors in the response.
+	 * @returns {Promise<GraphQlResponse[]>} - An array of responses from the GraphQL API.
+	 * @throws {Error} - If the request fails or if there are errors in any of the responses.
 	 */
-	executeBatch(graphqlQuery: string, headers?: Record<string, string>): Promise<GraphQlResponse>;
+	executeBatch(graphqlQueries: Array<string | GraphQLRequest>, headers?: Record<string, string>): Promise<GraphQlResponse[]>;
 	protected handleResponseData(responseData: any): void;
 }
 /**
@@ -1035,54 +1040,106 @@ export declare class GeoService {
 	createKey(origin: LatLng, destination: LatLng): string;
 }
 /**
- * A service class for handling GraphQL operations.
+ * Service for executing GraphQL queries and mutations.
  */
 export declare class GraphQLService {
 	private client;
 	/**
-	 * Creates an instance of GraphQLService.
-	 * @param {GraphQLClient} client - The GraphQL client to use for queries and mutations.
+	 * Constructor to initialize the GraphQL client.
+	 * @param {GraphQLClient} client - The GraphQL client instance.
 	 */
 	constructor(client: GraphQLClient);
 	/**
-	 * Executes a GraphQL query to fetch records.
-	 * @param {GraphqlQueryParams} params - The query parameters.
-	 * @returns {Promise<QueryResult>} - The query result including records, total count, page info, and cursors.
+	 * Executes a GraphQL query.
+	 * @param {GraphqlQueryParams} params - The parameters for the GraphQL query.
+	 * @returns {Promise<QueryResult>} - The query result containing records and pagination info.
+	 * @throws {Error} - If the query execution fails.
 	 */
 	query(params: GraphqlQueryParams): Promise<QueryResult>;
 	/**
-	 * Performs a mutation operation on the GraphQL API.
-	 * @param {string} objectName - The name of the object.
-	 * @param {HasId[]} records - The records to delete.
-	 * @returns {Promise<any>} - The response from the delete operation.
+	 * Executes a batch of queries.
+	 * @param {GraphQLQueryBuilder[]} builders - Array of query builders.
+	 * @returns {Promise<QueryResult[]>} - Array of query results.
+	 */
+	queryBatch(builders: GraphQLQueryBuilder[]): Promise<QueryResult[]>;
+	/**
+	 * Executes a batch of GraphQL queries.
+	 * @param {GraphqlQueryParams[]} paramsArray - An array of query parameters.
+	 * @returns {Promise<QueryResult[]>} - An array of query results.
+	 * @throws {Error} - If the batch execution fails.
 	 */
-	mutate(params: GraphqlMurationParams): Promise<any>;
+	private executeBatchQueries;
 	/**
-	 * Deletes records from the GraphQL API.
+	 * Executes a GraphQL mutation.
+	 * @param {GraphqlMutationParams} params - The parameters for the GraphQL mutation.
+	 * @returns {Promise<MutationResult>} - The mutation result containing affected UIDs.
+	 * @throws {Error} - If the mutation execution fails or the operation is invalid.
 	 */
-	delete(params: GraphqlMurationParams): Promise<any>;
+	mutate(params: GraphqlMutationParams): Promise<MutationResult>;
 	/**
-	 * Updates records in the GraphQL API.
+	 * Executes a batch of GraphQL mutations.
+	 * @param {GraphqlMutationParams[]} paramsArray - An array of mutation parameters.
+	 * @returns {Promise<MutationResult[]>} - An array of mutation results.
+	 * @throws {Error} - If the batch execution fails or if any mutation has empty records.
 	 */
-	update(params: GraphqlMurationParams): Promise<any>;
+	mutateBatch(paramsArray: GraphqlMutationParams[]): Promise<MutationResult[]>;
 	/**
-	 * Inserts records into the GraphQL API.
+	 * Deletes objects using a GraphQL mutation.
+	 * @param {GraphqlMutationParams} params - The parameters for the delete mutation.
+	 * @returns {Promise<MutationResult>} - The mutation result containing deleted UIDs.
+	 * @throws {Error} - If the delete operation fails.
 	 */
-	insert(params: GraphqlMurationParams): Promise<any>;
+	delete(params: GraphqlMutationParams): Promise<MutationResult>;
 	/**
-	 * Extracts job UIDs from a GraphQL mutation response.
-	 * @param {MutationResult} response - The response object.
-	 * @returns {string[]} - An array of job UIDs.
+	 * Updates objects using a GraphQL mutation.
+	 * @param {GraphqlMutationParams} params - The parameters for the update mutation.
+	 * @returns {Promise<MutationResult>} - The mutation result containing updated UIDs.
+	 * @throws {Error} - If the update operation fails.
 	 */
-	extractJobUIDs(response: MutationResult): string[];
+	update(params: GraphqlMutationParams): Promise<MutationResult>;
 	/**
-	 * Formats the object name to follow GraphQL naming conventions.
-	 * @param {string} objectName - The object name to format.
-	 * @returns {string} - The formatted object name.
+	 * Inserts objects using a GraphQL mutation.
+	 * @param {GraphqlMutationParams} params - The parameters for the insert mutation.
+	 * @returns {Promise<MutationResult>} - The mutation result containing inserted UIDs.
+	 * @throws {Error} - If the insert operation fails.
+	 */
+	insert(params: GraphqlMutationParams): Promise<MutationResult>;
+	/**
+	 * Upserts objects using a GraphQL mutation.
+	 * @param {GraphqlMutationParams} params - The parameters for the upsert mutation, including keyField.
+	 * @returns {Promise<MutationResult>} - The mutation result containing upserted UIDs.
+	 * @throws {Error} - If the upsert operation fails.
+	 */
+	upsert(params: GraphqlMutationParams): Promise<MutationResult>;
+	/**
+	 * Extracts UIDs from a mutation response.
+	 * @param {MutationResult} response - The mutation response containing the schema.
+	 * @returns {string[]} - An array of UIDs extracted from the response.
+	 */
+	extractUIDs(response: MutationResult): string[];
+	/**
+	 * Converts object name to GraphQL query name format.
+	 * @param {string} objectName - The object name to convert.
+	 * @returns {string} - The formatted query name.
 	 */
 	private getQueryName;
+	/**
+	 * Generates headers for GraphQL queries.
+	 * @param {GraphqlQueryParams} params - The query parameters containing operationName and readOnly flag.
+	 * @returns {Record<string, string>} - The headers for the query request.
+	 */
 	private getQueryHeaders;
+	/**
+	 * Generates headers for GraphQL mutations.
+	 * @param {GraphqlMutationParams} params - The mutation parameters containing operationName and optional flags.
+	 * @returns {Record<string, string>} - The headers for the mutation request.
+	 */
 	private getMutationHeaders;
+	/**
+	 * Generates operation header for GraphQL requests.
+	 * @param {string} operationName - The name of the GraphQL operation.
+	 * @returns {Record<string, string>} - The operation header.
+	 */
 	private getOperationHeader;
 }
 /**
@@ -1104,7 +1161,7 @@ export declare class GraphQLQueryBuilder {
 	private queryParams;
 	/**
 	 * Creates an instance of GraphQLQueryBuilder.
-	 * @param {string} graphqlQueryParams - The necessary parameters for the query.
+	 * @param {GraphqlQueryParams} queryParams - The parameters for the query.
 	 * @param {boolean} [isParent=false] - Indicates if this query is a parent query.
 	 */
 	constructor(queryParams: GraphqlQueryParams, isParent?: boolean);
@@ -1149,13 +1206,21 @@ export declare class GraphQLQueryBuilder {
 	 */
 	private formatQueryFields;
 	/**
-	 * Builds the GraphQL query parameters in a more structured format.
+	 * Builds the GraphQL query parameters in a structured format.
 	 */
 	build(): GraphqlQueryParams;
 	/**
-	 * Executes the query using the GraphQL service, with improved error handling.
+	 * Executes the query using the GraphQL service.
 	 */
 	execute(): Promise<QueryResult>;
+	/**
+	 * Executes all queries for the configured object, fetching records from the specified page range, up to a maximum of 20 pages.
+	 * @param {number} [fromPage=1] - The starting page number (1-based, defaults to 1).
+	 * @param {number} [toPage=20] - The ending page number (defaults to 20, capped at 20).
+	 * @returns {Promise<QueryResult>} - A query result containing all records in the page range and pagination info.
+	 * @throws {Error} - If the query execution fails, no GraphQL service is set, or invalid page parameters are provided.
+	 */
+	executeAll(fromPage?: number, toPage?: number): Promise<QueryResult>;
 	/**
 	 * Generates a string representation of the GraphQL query for debugging.
 	 */

package/dist/services/graphql/graphql-batch-builder.d.ts

@@ -0,0 +1,138 @@
+import { GraphQLService } from "./graphql-service";
+import { GraphqlQueryParams, QueryResult, MutationResult } from "../../interfaces/graphql";
+/**
+ * A utility class for building GraphQL queries or mutations dynamically.
+ */
+export declare class GraphQLQueryBuilder {
+    private objectName;
+    operationName: string;
+    private operationType;
+    private fields;
+    private filters;
+    private input;
+    private first?;
+    private offset?;
+    private orderBy?;
+    private after?;
+    private parentQueries;
+    private childQueries;
+    private isParent;
+    private graphqlService;
+    private queryParams;
+    /**
+     * Creates an instance of GraphQLQueryBuilder.
+     * @param queryParams - The parameters for the query or mutation.
+     * @param isParent - Indicates if this is a parent query.
+     */
+    constructor(queryParams: GraphqlQueryParams, isParent?: boolean);
+    /**
+     * Sets the GraphQL service to use for executing the operation.
+     * @param graphqlService - The GraphQL service instance.
+     * @returns The query builder instance for chaining.
+     */
+    setGraphqlService(graphqlService: GraphQLService): this;
+    /**
+     * Specifies the fields to be retrieved. Prevents duplicates.
+     * @param fields - Array of field names to include.
+     * @returns The query builder instance for chaining.
+     */
+    withFields(fields: string[]): this;
+    /**
+     * Adds a filter condition to the query.
+     * @param condition - The filter condition string.
+     * @returns The query builder instance for chaining.
+     * @throws Error if applied to a mutation or parent query.
+     */
+    withFilter(condition: string): this;
+    /**
+     * Sets the input object for a mutation.
+     * @param input - The mutation input object.
+     * @returns The query builder instance for chaining.
+     * @throws Error if applied to a query.
+     */
+    withInput(input: Record<string, any>): this;
+    /**
+     * Sets a limit on the number of records to retrieve.
+     * @param first - The maximum number of records.
+     * @returns The query builder instance for chaining.
+     * @throws Error if applied to a mutation or parent query.
+     */
+    withLimit(first: number): this;
+    /**
+     * Sets an offset for pagination.
+     * @param offset - The number of records to skip.
+     * @returns The query builder instance for chaining.
+     * @throws Error if applied to a mutation or parent query.
+     */
+    withOffset(offset: number): this;
+    /**
+     * Sets the order in which records should be retrieved.
+     * @param orderBy - The field to order by.
+     * @returns The query builder instance for chaining.
+     * @throws Error if applied to a mutation or parent query.
+     */
+    withOrderBy(orderBy: string): this;
+    /**
+     * Applies cursor-based pagination.
+     * @param after - The cursor to paginate after.
+     * @returns The query builder instance for chaining.
+     * @throws Error if applied to a mutation or parent query.
+     */
+    withCursor(after: string): this;
+    /**
+     * Creates a parent query.
+     * @param objectName - The name of the parent object.
+     * @returns The parent query builder instance.
+     */
+    withParentQuery(objectName: string): GraphQLQueryBuilder;
+    /**
+     * Creates a child query.
+     * @param objectName - The name of the child object.
+     * @returns The child query builder instance.
+     */
+    withChildQuery(objectName: string): GraphQLQueryBuilder;
+    /**
+     * Recursively builds the GraphQL query fields, handling nested queries.
+     * @returns The formatted fields string.
+     */
+    private formatQueryFields;
+    /**
+     * Builds the GraphQL operation parameters.
+     * @returns The structured query or mutation parameters.
+     */
+    build(): GraphqlQueryParams;
+    /**
+     * Executes the query or mutation.
+     * @returns A promise resolving to the operation result.
+     * @throws Error if no GraphQL service is set.
+     */
+    execute(): Promise<QueryResult | MutationResult>;
+    /**
+     * Generates a string representation of the GraphQL operation for debugging.
+     * @returns The formatted operation string.
+     */
+    toString(): string;
+}
+/**
+ * A utility class for building and executing a batch of GraphQL queries and mutations.
+ */
+export declare class GraphQLBatchBuilder {
+    private operations;
+    /**
+     * Adds a query or mutation to the batch.
+     * @param builder - The GraphQLQueryBuilder instance for the query or mutation.
+     * @returns The batch builder instance for chaining.
+     */
+    add(builder: GraphQLQueryBuilder): this;
+    /**
+     * Executes the batch of queries and mutations.
+     * @returns A promise resolving to an array of query or mutation results.
+     * @throws Error if no operations are added or if GraphQL service is missing.
+     */
+    execute(): Promise<(QueryResult | MutationResult)[]>;
+    /**
+     * Generates a string representation of the batch for debugging.
+     * @returns A string containing all operations in the batch.
+     */
+    toString(): string;
+}

package/dist/services/graphql/graphql-batch-builder.js

@@ -0,0 +1 @@
+"use strict";var __awaiter=this&&this.__awaiter||function(t,e,r,i){return new(r||(r=Promise))((function(o,s){function n(t){try{h(i.next(t))}catch(t){s(t)}}function a(t){try{h(i.throw(t))}catch(t){s(t)}}function h(t){var e;t.done?o(t.value):(e=t.value,e instanceof r?e:new r((function(t){t(e)}))).then(n,a)}h((i=i.apply(t,e||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.GraphQLBatchBuilder=exports.GraphQLQueryBuilder=void 0;const graphql_1=require("../../interfaces/graphql");class GraphQLQueryBuilder{constructor(t,e=!1){if(this.fields=new Set(["UID"]),this.filters=[],this.input=null,this.parentQueries={},this.childQueries={},this.graphqlService=null,!t.objectName||!t.operationName)throw new Error("objectName and operationName are required.");this.queryParams=t,this.objectName=t.objectName.charAt(0).toLowerCase()+t.objectName.slice(1),this.operationName=t.operationName,this.operationType=t.operationType||"query",this.isParent=e}setGraphqlService(t){return this.graphqlService=t,this}withFields(t){return t.forEach((t=>this.fields.add(t))),this}withFilter(t){if("mutation"===this.operationType)throw new Error("Cannot apply filters to a mutation.");if(this.isParent)throw new Error(`Cannot apply filters to parent query for object: ${this.objectName}`);return this.filters.push(t),this}withInput(t){if("query"===this.operationType)throw new Error("Cannot apply input to a query.");if(!t||0===Object.keys(t).length)throw new Error("Mutation input cannot be empty.");return this.input=t,this}withLimit(t){if("mutation"===this.operationType)throw new Error("Cannot apply limit to a mutation.");if(this.isParent)throw new Error(`Cannot apply limit to parent query for object: ${this.objectName}`);return this.first=t,this}withOffset(t){if("mutation"===this.operationType)throw new Error("Cannot apply offset to a mutation.");if(this.isParent)throw new Error(`Cannot apply offset to parent query for object: ${this.objectName}`);return this.offset=t,this}withOrderBy(t){if("mutation"===this.operationType)throw new Error("Cannot apply orderBy to a mutation.");if(this.isParent)throw new Error(`Cannot apply orderBy to parent query for object: ${this.objectName}`);return this.orderBy=t,this}withCursor(t){if("mutation"===this.operationType)throw new Error("Cannot apply cursor to a mutation.");if(this.isParent)throw new Error(`Cannot apply cursor to parent query for object: ${this.objectName}`);return this.after=t,this}withParentQuery(t){const e=new GraphQLQueryBuilder({objectName:t,operationName:this.operationName,operationType:this.operationType},!0);return this.parentQueries[t]=e,e}withChildQuery(t){const e=new GraphQLQueryBuilder({objectName:t,operationName:this.operationName,operationType:this.operationType});return this.childQueries[t]=e,e}formatQueryFields(){const t=[...this.fields];for(const[e,r]of Object.entries(this.parentQueries))t.push(`${e} { ${r.formatQueryFields()} }`);for(const[e,r]of Object.entries(this.childQueries)){const i=r.build(),o=i.filter?`(filter: "${i.filter}")`:"";t.push(`${e} ${o} { ${i.fields||"UID"} }`)}return t.filter(Boolean).join(", ")}build(){const t={objectName:this.objectName,operationName:this.operationName,operationType:this.operationType,fields:this.formatQueryFields(),readOnly:this.queryParams.readOnly};return"query"===this.operationType?(t.filter=this.filters.length>0?this.filters.join(" AND "):void 0,t.first=this.first,t.offset=this.offset,t.orderBy=this.orderBy,t.after=this.after):t.input=this.input||void 0,t}execute(){var t;if(!this.graphqlService)throw new Error(`No GraphQL service set for ${this.operationType} execution on ${this.objectName}.`);const e=this.build();if("mutation"===this.operationType){const r={objectName:this.objectName,operationName:this.operationName,operation:(null===(t=this.input)||void 0===t?void 0:t.operation)||graphql_1.GraphqlOperations.UPDATE,records:this.input?[this.input]:[],fields:e.fields?e.fields.split(", "):["UID"]};return this.graphqlService.mutate(r)}return this.graphqlService.query(e)}toString(){const t=[];"query"===this.operationType?(this.first&&t.push(`first: ${this.first}`),this.offset&&t.push(`offset: ${this.offset}`),this.orderBy&&t.push(`orderBy: "${this.orderBy}"`),this.after&&t.push(`after: "${this.after}"`),this.filters.length&&t.push(`filter: "${this.filters.join(" AND ")}"`)):this.input&&t.push(`input: ${JSON.stringify(this.input)}`);const e=t.length?`(${t.join(", ")})`:"";return`${this.operationType} ${this.operationName} { ${this.objectName}${e} { ${this.formatQueryFields()} } }`}}exports.GraphQLQueryBuilder=GraphQLQueryBuilder;class GraphQLBatchBuilder{constructor(){this.operations=[]}add(t){return this.operations.push(t),this}execute(){return __awaiter(this,void 0,void 0,(function*(){if(!this.operations.length)return[];const t=this.operations[0].graphqlService;if(!t)throw new Error("No GraphQL service set for batch execution.");if(this.operations.some((e=>e.graphqlService!==t)))throw new Error("All operations must use the same GraphQL service.");const e=this.operations.map((t=>t.build()));return t.executeBatch(e)}))}toString(){return this.operations.map((t=>t.toString())).join("\n")}}exports.GraphQLBatchBuilder=GraphQLBatchBuilder;

package/dist/services/graphql/graphql-query-batch.d.ts

@@ -0,0 +1,10 @@
+import { QueryResult } from "../../interfaces";
+import { GraphQLQueryBuilder } from "./graphql-query-builder";
+export declare class GraphQLQueryBatch {
+    /**
+     * Executes a batch of queries.
+     * @param {GraphQLQueryBuilder[]} builders - Array of query builders.
+     * @returns {Promise<QueryResult[]>} - Array of query results.
+     */
+    execute(builders: GraphQLQueryBuilder[]): Promise<QueryResult[]>;
+}

package/dist/services/graphql/graphql-query-batch.js

@@ -0,0 +1 @@
+"use strict";var __awaiter=this&&this.__awaiter||function(t,e,r,n){return new(r||(r=Promise))((function(a,c){function i(t){try{u(n.next(t))}catch(t){c(t)}}function o(t){try{u(n.throw(t))}catch(t){c(t)}}function u(t){var e;t.done?a(t.value):(e=t.value,e instanceof r?e:new r((function(t){t(e)}))).then(i,o)}u((n=n.apply(t,e||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.GraphQLQueryBatch=void 0;class GraphQLQueryBatch{execute(t){return __awaiter(this,void 0,void 0,(function*(){if(!t.length)return[];const e=t[0].graphqlService;if(!e)throw new Error("No GraphQL service set for batch execution.");const r=t.map((t=>t.build()));return e.queryBatch(r)}))}}exports.GraphQLQueryBatch=GraphQLQueryBatch;

package/dist/services/graphql/graphql-query-builder.d.ts

@@ -19,7 +19,7 @@ export declare class GraphQLQueryBuilder {
     private queryParams;
     /**
      * Creates an instance of GraphQLQueryBuilder.
-     * @param {string} graphqlQueryParams - The necessary parameters for the query.
+     * @param {GraphqlQueryParams} queryParams - The parameters for the query.
      * @param {boolean} [isParent=false] - Indicates if this query is a parent query.
      */
     constructor(queryParams: GraphqlQueryParams, isParent?: boolean);
@@ -64,13 +64,21 @@ export declare class GraphQLQueryBuilder {
      */
     private formatQueryFields;
     /**
-     * Builds the GraphQL query parameters in a more structured format.
+     * Builds the GraphQL query parameters in a structured format.
      */
     build(): GraphqlQueryParams;
     /**
-     * Executes the query using the GraphQL service, with improved error handling.
+     * Executes the query using the GraphQL service.
      */
     execute(): Promise<QueryResult>;
+    /**
+     * Executes all queries for the configured object, fetching records from the specified page range, up to a maximum of 20 pages.
+     * @param {number} [fromPage=1] - The starting page number (1-based, defaults to 1).
+     * @param {number} [toPage=20] - The ending page number (defaults to 20, capped at 20).
+     * @returns {Promise<QueryResult>} - A query result containing all records in the page range and pagination info.
+     * @throws {Error} - If the query execution fails, no GraphQL service is set, or invalid page parameters are provided.
+     */
+    executeAll(fromPage?: number, toPage?: number): Promise<QueryResult>;
     /**
      * Generates a string representation of the GraphQL query for debugging.
      */

package/dist/services/graphql/graphql-query-builder.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.GraphQLQueryBuilder=void 0;class GraphQLQueryBuilder{constructor(e,r=!1){this.fields=new Set(["UID"]),this.filters=[],this.parentQueries={},this.childQueries={},this.graphqlService=null,this.queryParams=e,this.objectName=e.objectName.charAt(0).toLowerCase()+e.objectName.slice(1),this.operationName=e.operationName,this.isParent=r}setGraphqlService(e){this.graphqlService=e}withFields(e){return e.forEach((e=>this.fields.add(e))),this}withFilter(e){if(this.isParent)throw new Error("Cannot apply filters to a parent query.");return this.filters.push(e),this}withLimit(e){if(this.isParent)throw new Error("Cannot apply limit to a parent query.");return this.first=e,this}withOffset(e){if(this.isParent)throw new Error("Cannot apply offset to a parent query.");return this.offset=e,this}withOrderBy(e){if(this.isParent)throw new Error("Cannot apply orderBy to a parent query.");return this.orderBy=e,this}withCursor(e){if(this.isParent)throw new Error("Cannot apply cursor to a parent query.");return this.after=e,this}withParentQuery(e){const r=new GraphQLQueryBuilder({objectName:e,operationName:this.operationName},!0);return this.parentQueries[e]=r,r}withChildQuery(e){const r=new GraphQLQueryBuilder({objectName:e,operationName:this.operationName});return this.childQueries[e]=r,r}formatQueryFields(){const e=Object.entries(this.parentQueries).map((([e,r])=>`${e} { ${r.formatQueryFields()} }`)).join(", "),r=Object.entries(this.childQueries).map((([e,r])=>{const t=r.build();return`${e} ${t.filter?`(filter: "${t.filter}")`:""} { ${t.fields} }`})).join(", ");return[...this.fields,e,r].filter(Boolean).join(", ")}build(){return{objectName:this.objectName,operationName:this.operationName,fields:this.formatQueryFields(),filter:this.filters.length>0?this.filters.join(" AND "):void 0,first:this.first,offset:this.offset,orderBy:this.orderBy,after:this.after}}execute(){if(!this.graphqlService)return Promise.reject(new Error("No GraphQL service set for query execution."));const e=this.build();return e.readOnly=this.queryParams.readOnly,this.graphqlService.query(e)}toString(){return`{ ${this.objectName} { ${this.formatQueryFields()} } }`}}exports.GraphQLQueryBuilder=GraphQLQueryBuilder;
+"use strict";var __awaiter=this&&this.__awaiter||function(e,t,r,i){return new(r||(r=Promise))((function(s,a){function o(e){try{h(i.next(e))}catch(e){a(e)}}function n(e){try{h(i.throw(e))}catch(e){a(e)}}function h(e){var t;e.done?s(e.value):(t=e.value,t instanceof r?t:new r((function(e){e(t)}))).then(o,n)}h((i=i.apply(e,t||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.GraphQLQueryBuilder=void 0;class GraphQLQueryBuilder{constructor(e,t=!1){this.fields=new Set(["UID"]),this.filters=[],this.parentQueries={},this.childQueries={},this.graphqlService=null,this.queryParams=e,this.objectName=e.objectName.charAt(0).toLowerCase()+e.objectName.slice(1),this.operationName=e.operationName,this.isParent=t}setGraphqlService(e){this.graphqlService=e}withFields(e){return e.forEach((e=>this.fields.add(e))),this}withFilter(e){if(this.isParent)throw new Error("Cannot apply filters to a parent query.");return this.filters.push(e),this}withLimit(e){if(this.isParent)throw new Error("Cannot apply limit to a parent query.");return this.first=e,this}withOffset(e){if(this.isParent)throw new Error("Cannot apply offset to a parent query.");return this.offset=e,this}withOrderBy(e){if(this.isParent)throw new Error("Cannot apply orderBy to a parent query.");return this.orderBy=e,this}withCursor(e){if(this.isParent)throw new Error("Cannot apply cursor to a parent query.");return this.after=e,this}withParentQuery(e){const t=new GraphQLQueryBuilder({objectName:e,operationName:this.operationName},!0);return this.parentQueries[e]=t,t}withChildQuery(e){const t=new GraphQLQueryBuilder({objectName:e,operationName:this.operationName});return this.childQueries[e]=t,t}formatQueryFields(){const e=Object.entries(this.parentQueries).map((([e,t])=>`${e} { ${t.formatQueryFields()} }`)).join(", "),t=Object.entries(this.childQueries).map((([e,t])=>{const r=t.build();return`${e} ${r.filter?`(filter: "${r.filter}")`:""} { ${r.fields||"UID"} }`})).join(", ");return[...this.fields,e,t].filter(Boolean).join(", ")}build(){return{objectName:this.objectName,operationName:this.operationName,fields:this.formatQueryFields(),filter:this.filters.length>0?this.filters.join(" AND "):void 0,first:this.first,offset:this.offset,orderBy:this.orderBy,after:this.after,readOnly:this.queryParams.readOnly}}execute(){if(!this.graphqlService)return Promise.reject(new Error("No GraphQL service set for query execution."));const e=this.build();return e.readOnly=this.queryParams.readOnly,this.graphqlService.query(e)}executeAll(){return __awaiter(this,arguments,void 0,(function*(e=1,t=20){if(!this.graphqlService)throw new Error("No GraphQL service set for query execution.");if(e<1)throw new Error("fromPage must be at least 1.");if(t<e)throw new Error("toPage must be greater than or equal to fromPage.");const r=Math.min(t,20),i=this.build(),s=yield this.graphqlService.query(i),a=s.totalCount;if(0===a)return{records:[],totalCount:0,pageInfo:{hasNextPage:!1},endCursor:"",endOffset:0};const o=this.first||200,n=Math.ceil(a/o),h=Math.min(r,n);if(0===Math.max(0,h-e+1))return{records:[],totalCount:a,pageInfo:{hasNextPage:h<n},endCursor:"",endOffset:(e-1)*o};const u=[];for(let t=e-1;t<h;t++){const e=new GraphQLQueryBuilder({objectName:this.objectName,operationName:this.operationName,readOnly:this.queryParams.readOnly});e.setGraphqlService(this.graphqlService),e.fields=new Set(this.fields),e.filters=[...this.filters],e.first=o,e.offset=t*o,e.orderBy=this.orderBy,e.after=this.after,u.push(e)}const l=yield this.graphqlService.queryBatch(u),f=l.flatMap((e=>e.records)),c=l[l.length-1];return{records:f,totalCount:s.totalCount,pageInfo:c.pageInfo,endCursor:c.endCursor,endOffset:c.endOffset}}))}toString(){return`{ ${this.objectName} { ${this.formatQueryFields()} } }`}}exports.GraphQLQueryBuilder=GraphQLQueryBuilder;

package/dist/services/graphql/graphql-service.d.ts

@@ -1,53 +1,106 @@
 import { GraphQLClient } from "../../clients/graphql-client";
-import { GraphqlMurationParams, GraphqlQueryParams, MutationResult, QueryResult } from "../../interfaces/graphql";
+import { GraphqlMutationParams, GraphqlQueryParams, MutationResult, QueryResult } from "../../interfaces/graphql";
+import { GraphQLQueryBuilder } from "./graphql-query-builder";
 /**
- * A service class for handling GraphQL operations.
+ * Service for executing GraphQL queries and mutations.
  */
 export declare class GraphQLService {
     private client;
     /**
-     * Creates an instance of GraphQLService.
-     * @param {GraphQLClient} client - The GraphQL client to use for queries and mutations.
+     * Constructor to initialize the GraphQL client.
+     * @param {GraphQLClient} client - The GraphQL client instance.
      */
     constructor(client: GraphQLClient);
     /**
-     * Executes a GraphQL query to fetch records.
-     * @param {GraphqlQueryParams} params - The query parameters.
-     * @returns {Promise<QueryResult>} - The query result including records, total count, page info, and cursors.
+     * Executes a GraphQL query.
+     * @param {GraphqlQueryParams} params - The parameters for the GraphQL query.
+     * @returns {Promise<QueryResult>} - The query result containing records and pagination info.
+     * @throws {Error} - If the query execution fails.
      */
     query(params: GraphqlQueryParams): Promise<QueryResult>;
     /**
-     * Performs a mutation operation on the GraphQL API.
-     * @param {string} objectName - The name of the object.
-     * @param {HasId[]} records - The records to delete.
-     * @returns {Promise<any>} - The response from the delete operation.
+     * Executes a batch of queries.
+     * @param {GraphQLQueryBuilder[]} builders - Array of query builders.
+     * @returns {Promise<QueryResult[]>} - Array of query results.
      */
-    mutate(params: GraphqlMurationParams): Promise<any>;
+    queryBatch(builders: GraphQLQueryBuilder[]): Promise<QueryResult[]>;
     /**
-     * Deletes records from the GraphQL API.
+     * Executes a batch of GraphQL queries.
+     * @param {GraphqlQueryParams[]} paramsArray - An array of query parameters.
+     * @returns {Promise<QueryResult[]>} - An array of query results.
+     * @throws {Error} - If the batch execution fails.
      */
-    delete(params: GraphqlMurationParams): Promise<any>;
+    private executeBatchQueries;
     /**
-     * Updates records in the GraphQL API.
+     * Executes a GraphQL mutation.
+     * @param {GraphqlMutationParams} params - The parameters for the GraphQL mutation.
+     * @returns {Promise<MutationResult>} - The mutation result containing affected UIDs.
+     * @throws {Error} - If the mutation execution fails or the operation is invalid.
      */
-    update(params: GraphqlMurationParams): Promise<any>;
+    mutate(params: GraphqlMutationParams): Promise<MutationResult>;
     /**
-     * Inserts records into the GraphQL API.
+     * Executes a batch of GraphQL mutations.
+     * @param {GraphqlMutationParams[]} paramsArray - An array of mutation parameters.
+     * @returns {Promise<MutationResult[]>} - An array of mutation results.
+     * @throws {Error} - If the batch execution fails or if any mutation has empty records.
      */
-    insert(params: GraphqlMurationParams): Promise<any>;
+    mutateBatch(paramsArray: GraphqlMutationParams[]): Promise<MutationResult[]>;
     /**
-     * Extracts job UIDs from a GraphQL mutation response.
-     * @param {MutationResult} response - The response object.
-     * @returns {string[]} - An array of job UIDs.
+     * Deletes objects using a GraphQL mutation.
+     * @param {GraphqlMutationParams} params - The parameters for the delete mutation.
+     * @returns {Promise<MutationResult>} - The mutation result containing deleted UIDs.
+     * @throws {Error} - If the delete operation fails.
      */
-    extractJobUIDs(response: MutationResult): string[];
+    delete(params: GraphqlMutationParams): Promise<MutationResult>;
     /**
-     * Formats the object name to follow GraphQL naming conventions.
-     * @param {string} objectName - The object name to format.
-     * @returns {string} - The formatted object name.
+     * Updates objects using a GraphQL mutation.
+     * @param {GraphqlMutationParams} params - The parameters for the update mutation.
+     * @returns {Promise<MutationResult>} - The mutation result containing updated UIDs.
+     * @throws {Error} - If the update operation fails.
+     */
+    update(params: GraphqlMutationParams): Promise<MutationResult>;
+    /**
+     * Inserts objects using a GraphQL mutation.
+     * @param {GraphqlMutationParams} params - The parameters for the insert mutation.
+     * @returns {Promise<MutationResult>} - The mutation result containing inserted UIDs.
+     * @throws {Error} - If the insert operation fails.
+     */
+    insert(params: GraphqlMutationParams): Promise<MutationResult>;
+    /**
+     * Upserts objects using a GraphQL mutation.
+     * @param {GraphqlMutationParams} params - The parameters for the upsert mutation, including keyField.
+     * @returns {Promise<MutationResult>} - The mutation result containing upserted UIDs.
+     * @throws {Error} - If the upsert operation fails.
+     */
+    upsert(params: GraphqlMutationParams): Promise<MutationResult>;
+    /**
+     * Extracts UIDs from a mutation response.
+     * @param {MutationResult} response - The mutation response containing the schema.
+     * @returns {string[]} - An array of UIDs extracted from the response.
+     */
+    extractUIDs(response: MutationResult): string[];
+    /**
+     * Converts object name to GraphQL query name format.
+     * @param {string} objectName - The object name to convert.
+     * @returns {string} - The formatted query name.
      */
     private getQueryName;
+    /**
+     * Generates headers for GraphQL queries.
+     * @param {GraphqlQueryParams} params - The query parameters containing operationName and readOnly flag.
+     * @returns {Record<string, string>} - The headers for the query request.
+     */
     private getQueryHeaders;
+    /**
+     * Generates headers for GraphQL mutations.
+     * @param {GraphqlMutationParams} params - The mutation parameters containing operationName and optional flags.
+     * @returns {Record<string, string>} - The headers for the mutation request.
+     */
     private getMutationHeaders;
+    /**
+     * Generates operation header for GraphQL requests.
+     * @param {string} operationName - The name of the GraphQL operation.
+     * @returns {Record<string, string>} - The operation header.
+     */
     private getOperationHeader;
 }

package/dist/services/graphql/graphql-service.js

@@ -1 +1 @@
-"use strict";var __decorate=this&&this.__decorate||function(e,t,a,r){var o,n=arguments.length,i=n<3?t:null===r?r=Object.getOwnPropertyDescriptor(t,a):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)i=Reflect.decorate(e,t,a,r);else for(var s=e.length-1;s>=0;s--)(o=e[s])&&(i=(n<3?o(i):n>3?o(t,a,i):o(t,a))||i);return n>3&&i&&Object.defineProperty(t,a,i),i},__metadata=this&&this.__metadata||function(e,t){if("object"==typeof Reflect&&"function"==typeof Reflect.metadata)return Reflect.metadata(e,t)},__awaiter=this&&this.__awaiter||function(e,t,a,r){return new(a||(a=Promise))((function(o,n){function i(e){try{d(r.next(e))}catch(e){n(e)}}function s(e){try{d(r.throw(e))}catch(e){n(e)}}function d(e){var t;e.done?o(e.value):(t=e.value,t instanceof a?t:new a((function(e){e(t)}))).then(i,s)}d((r=r.apply(e,t||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.GraphQLService=void 0;const constants_1=require("../../constants"),request_header_constants_1=require("../../core/request-header-constants"),logging_1=require("../../logging"),queries_1=require("./queries");class GraphQLService{constructor(e){this.client=e}query(e){return __awaiter(this,void 0,void 0,(function*(){var t,a,r,o,n,i,s,d,u,_,c,l;e.objectName=this.getQueryName(e.objectName);const p=(0,queries_1.FETCH_RECORDS_QUERY)(e),v=this.getQueryHeaders(e),g=yield this.client.execute(p,v),h={records:(null===(a=null===(t=null==g?void 0:g.data)||void 0===t?void 0:t[e.objectName])||void 0===a?void 0:a.edges.map((e=>e.node)))||[],totalCount:(null===(o=null===(r=null==g?void 0:g.data)||void 0===r?void 0:r[e.objectName])||void 0===o?void 0:o.totalCount)||0,pageInfo:(null===(i=null===(n=null==g?void 0:g.data)||void 0===n?void 0:n[e.objectName])||void 0===i?void 0:i.pageInfo)||{}};if(h.records.length>0){const t=(null===(u=null===(d=null===(s=null==g?void 0:g.data)||void 0===s?void 0:s[e.objectName])||void 0===d?void 0:d.edges)||void 0===u?void 0:u.map((e=>e.offset)))||[],a=(null===(l=null===(c=null===(_=null==g?void 0:g.data)||void 0===_?void 0:_[e.objectName])||void 0===c?void 0:c.edges)||void 0===l?void 0:l.map((e=>e.cursor)))||[];h.endOffset=t[t.length-1],h.endCursor=a[a.length-1]}return h}))}mutate(e){return __awaiter(this,void 0,void 0,(function*(){if(!e.records||0===e.records.length)return Promise.resolve({message:"No records to process"});let t="";switch(e.operation){case constants_1.GraphqlOperations.DELETE:t=(0,queries_1.DELETE_OBJECTS_MUTATION)(e);break;case constants_1.GraphqlOperations.UPDATE:case constants_1.GraphqlOperations.INSERT:t=(0,queries_1.UPSERT_OBJECTS_MUTATION)(e);break;default:throw new Error(`Invalid operation: ${e.operation}`)}const a=this.getMutationHeaders(e);return yield this.client.execute(t,a)}))}delete(e){return __awaiter(this,void 0,void 0,(function*(){return e.operation=constants_1.GraphqlOperations.DELETE,this.mutate(e)}))}update(e){return __awaiter(this,void 0,void 0,(function*(){return e.operation=constants_1.GraphqlOperations.UPDATE,this.mutate(e)}))}insert(e){return __awaiter(this,void 0,void 0,(function*(){return e.operation=constants_1.GraphqlOperations.INSERT,this.mutate(e)}))}extractJobUIDs(e){var t;return(null===(t=null==e?void 0:e.data)||void 0===t?void 0:t.schema)?Object.values(e.data.schema):[]}getQueryName(e){return e.charAt(0).toLowerCase()+e.slice(1)}getQueryHeaders(e){const t=this.getOperationHeader(e.operationName);return e.readOnly&&(t[request_header_constants_1.REQUEST_HEADERS.X_SKEDULO_READ_ONLY]="true"),t}getMutationHeaders(e){const t=this.getOperationHeader(e.operationName);return e.bulkOperation&&(t[request_header_constants_1.REQUEST_HEADERS.X_SKEDULO_BULK_OPERATION]="true"),e.suppressChangeEvents&&(t[request_header_constants_1.REQUEST_HEADERS.X_SKEDULO_SUPPRESS_CHANGE_EVENTS]="true"),t}getOperationHeader(e){return{[request_header_constants_1.REQUEST_HEADERS.X_GRAPHQL_OPERATION]:e}}}exports.GraphQLService=GraphQLService,__decorate([(0,logging_1.LogMethod)(),__metadata("design:type",Function),__metadata("design:paramtypes",[Object]),__metadata("design:returntype",Promise)],GraphQLService.prototype,"query",null),__decorate([(0,logging_1.LogMethod)(),__metadata("design:type",Function),__metadata("design:paramtypes",[Object]),__metadata("design:returntype",Promise)],GraphQLService.prototype,"mutate",null),__decorate([(0,logging_1.LogMethod)(),__metadata("design:type",Function),__metadata("design:paramtypes",[Object]),__metadata("design:returntype",Promise)],GraphQLService.prototype,"delete",null),__decorate([(0,logging_1.LogMethod)(),__metadata("design:type",Function),__metadata("design:paramtypes",[Object]),__metadata("design:returntype",Promise)],GraphQLService.prototype,"update",null),__decorate([(0,logging_1.LogMethod)(),__metadata("design:type",Function),__metadata("design:paramtypes",[Object]),__metadata("design:returntype",Promise)],GraphQLService.prototype,"insert",null);
+"use strict";var __decorate=this&&this.__decorate||function(e,t,a,r){var o,n=arguments.length,i=n<3?t:null===r?r=Object.getOwnPropertyDescriptor(t,a):r;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)i=Reflect.decorate(e,t,a,r);else for(var s=e.length-1;s>=0;s--)(o=e[s])&&(i=(n<3?o(i):n>3?o(t,a,i):o(t,a))||i);return n>3&&i&&Object.defineProperty(t,a,i),i},__metadata=this&&this.__metadata||function(e,t){if("object"==typeof Reflect&&"function"==typeof Reflect.metadata)return Reflect.metadata(e,t)},__awaiter=this&&this.__awaiter||function(e,t,a,r){return new(a||(a=Promise))((function(o,n){function i(e){try{d(r.next(e))}catch(e){n(e)}}function s(e){try{d(r.throw(e))}catch(e){n(e)}}function d(e){var t;e.done?o(e.value):(t=e.value,t instanceof a?t:new a((function(e){e(t)}))).then(i,s)}d((r=r.apply(e,t||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.GraphQLService=void 0;const constants_1=require("../../constants"),request_header_constants_1=require("../../core/request-header-constants"),logging_1=require("../../logging"),queries_1=require("./queries");class GraphQLService{constructor(e){this.client=e}query(e){return __awaiter(this,void 0,void 0,(function*(){var t,a,r,o,n,i,s,d,u,c,_,l;e.objectName=this.getQueryName(e.objectName);const p=(0,queries_1.FETCH_RECORDS_QUERY)(e),h=this.getQueryHeaders(e),v=yield this.client.execute(p,h),g={records:(null===(a=null===(t=null==v?void 0:v.data)||void 0===t?void 0:t[e.objectName])||void 0===a?void 0:a.edges.map((e=>e.node)))||[],totalCount:(null===(o=null===(r=null==v?void 0:v.data)||void 0===r?void 0:r[e.objectName])||void 0===o?void 0:o.totalCount)||0,pageInfo:(null===(i=null===(n=null==v?void 0:v.data)||void 0===n?void 0:n[e.objectName])||void 0===i?void 0:i.pageInfo)||{}};if(g.records.length>0){const t=(null===(u=null===(d=null===(s=null==v?void 0:v.data)||void 0===s?void 0:s[e.objectName])||void 0===d?void 0:d.edges)||void 0===u?void 0:u.map((e=>e.offset)))||[],a=(null===(l=null===(_=null===(c=null==v?void 0:v.data)||void 0===c?void 0:c[e.objectName])||void 0===_?void 0:_.edges)||void 0===l?void 0:l.map((e=>e.cursor)))||[];g.endOffset=t[t.length-1],g.endCursor=a[a.length-1]}return g}))}queryBatch(e){return __awaiter(this,void 0,void 0,(function*(){if(!e.length)return[];const t=e.map((e=>e.build()));return this.executeBatchQueries(t)}))}executeBatchQueries(e){return __awaiter(this,void 0,void 0,(function*(){if(!e.length)return[];const t=e.map((e=>{const t=Object.assign(Object.assign({},e),{objectName:this.getQueryName(e.objectName)});return(0,queries_1.FETCH_RECORDS_QUERY)(t)})),a=this.getQueryHeaders(e[0]);return(yield this.client.executeBatch(t,a)).map(((t,a)=>{var r,o,n,i,s,d,u,c,_,l,p,h;const v=e[a],g={records:(null===(o=null===(r=null==t?void 0:t.data)||void 0===r?void 0:r[v.objectName])||void 0===o?void 0:o.edges.map((e=>e.node)))||[],totalCount:(null===(i=null===(n=null==t?void 0:t.data)||void 0===n?void 0:n[v.objectName])||void 0===i?void 0:i.totalCount)||0,pageInfo:(null===(d=null===(s=null==t?void 0:t.data)||void 0===s?void 0:s[v.objectName])||void 0===d?void 0:d.pageInfo)||{}};if(g.records.length>0){const e=(null===(_=null===(c=null===(u=null==t?void 0:t.data)||void 0===u?void 0:u[v.objectName])||void 0===c?void 0:c.edges)||void 0===_?void 0:_.map((e=>e.offset)))||[],a=(null===(h=null===(p=null===(l=null==t?void 0:t.data)||void 0===l?void 0:l[v.objectName])||void 0===p?void 0:p.edges)||void 0===h?void 0:h.map((e=>e.cursor)))||[];g.endOffset=e[e.length-1],g.endCursor=a[a.length-1]}return g}))}))}mutate(e){return __awaiter(this,void 0,void 0,(function*(){if(!e.records||0===e.records.length)return Promise.resolve({data:{schema:{}}});let t="";switch(e.operation){case constants_1.GraphqlOperations.DELETE:t=(0,queries_1.DELETE_OBJECTS_MUTATION)(e);break;case constants_1.GraphqlOperations.INSERT:case constants_1.GraphqlOperations.UPDATE:case constants_1.GraphqlOperations.UPSERT:t=(0,queries_1.MUTATE_OBJECTS_MUTATION)(e);break;default:throw new Error(`Invalid operation: ${e.operation}`)}const a=this.getMutationHeaders(e);return yield this.client.execute(t,a)}))}mutateBatch(e){return __awaiter(this,void 0,void 0,(function*(){if(!e.length)return[];e.forEach(((e,t)=>{if(!e.records||0===e.records.length)throw new Error(`Mutation at index ${t} has empty or null records for operation '${e.operationName}'`)}));const t=e.map((e=>{switch(e.operation){case constants_1.GraphqlOperations.DELETE:return(0,queries_1.DELETE_OBJECTS_MUTATION)(e);case constants_1.GraphqlOperations.INSERT:case constants_1.GraphqlOperations.UPDATE:case constants_1.GraphqlOperations.UPSERT:return(0,queries_1.MUTATE_OBJECTS_MUTATION)(e);default:throw new Error(`Invalid operation: ${e.operation}`)}})),a=this.getMutationHeaders(e[0]);return yield this.client.executeBatch(t,a)}))}delete(e){return __awaiter(this,void 0,void 0,(function*(){return e.operation=constants_1.GraphqlOperations.DELETE,this.mutate(e)}))}update(e){return __awaiter(this,void 0,void 0,(function*(){return e.operation=constants_1.GraphqlOperations.UPDATE,this.mutate(e)}))}insert(e){return __awaiter(this,void 0,void 0,(function*(){return e.operation=constants_1.GraphqlOperations.INSERT,this.mutate(e)}))}upsert(e){return __awaiter(this,void 0,void 0,(function*(){return e.operation=constants_1.GraphqlOperations.UPSERT,this.mutate(e)}))}extractUIDs(e){var t;return(null===(t=null==e?void 0:e.data)||void 0===t?void 0:t.schema)?Object.values(e.data.schema):[]}getQueryName(e){return e.charAt(0).toLowerCase()+e.slice(1)}getQueryHeaders(e){const t=this.getOperationHeader(e.operationName);return e.readOnly&&(t[request_header_constants_1.REQUEST_HEADERS.X_SKEDULO_READ_ONLY]="true"),t}getMutationHeaders(e){const t=this.getOperationHeader(e.operationName);return e.bulkOperation&&(t[request_header_constants_1.REQUEST_HEADERS.X_SKEDULO_BULK_OPERATION]="true"),e.suppressChangeEvents&&(t[request_header_constants_1.REQUEST_HEADERS.X_SKEDULO_SUPPRESS_CHANGE_EVENTS]="true"),t}getOperationHeader(e){return{[request_header_constants_1.REQUEST_HEADERS.X_GRAPHQL_OPERATION]:e}}}exports.GraphQLService=GraphQLService,__decorate([(0,logging_1.LogMethod)(),__metadata("design:type",Function),__metadata("design:paramtypes",[Object]),__metadata("design:returntype",Promise)],GraphQLService.prototype,"query",null),__decorate([(0,logging_1.LogMethod)(),__metadata("design:type",Function),__metadata("design:paramtypes",[Array]),__metadata("design:returntype",Promise)],GraphQLService.prototype,"queryBatch",null),__decorate([(0,logging_1.LogMethod)(),__metadata("design:type",Function),__metadata("design:paramtypes",[Object]),__metadata("design:returntype",Promise)],GraphQLService.prototype,"mutate",null),__decorate([(0,logging_1.LogMethod)(),__metadata("design:type",Function),__metadata("design:paramtypes",[Array]),__metadata("design:returntype",Promise)],GraphQLService.prototype,"mutateBatch",null),__decorate([(0,logging_1.LogMethod)(),__metadata("design:type",Function),__metadata("design:paramtypes",[Object]),__metadata("design:returntype",Promise)],GraphQLService.prototype,"delete",null),__decorate([(0,logging_1.LogMethod)(),__metadata("design:type",Function),__metadata("design:paramtypes",[Object]),__metadata("design:returntype",Promise)],GraphQLService.prototype,"update",null),__decorate([(0,logging_1.LogMethod)(),__metadata("design:type",Function),__metadata("design:paramtypes",[Object]),__metadata("design:returntype",Promise)],GraphQLService.prototype,"insert",null),__decorate([(0,logging_1.LogMethod)(),__metadata("design:type",Function),__metadata("design:paramtypes",[Object]),__metadata("design:returntype",Promise)],GraphQLService.prototype,"upsert",null);

package/dist/services/graphql/queries.d.ts

@@ -1,26 +1,20 @@
-import { GraphqlMurationParams, GraphqlQueryParams } from "../../interfaces/graphql";
+import { GraphqlMutationParams, GraphqlQueryParams } from "../../interfaces/graphql";
 /**
- * Constructs a GraphQL query for fetching records with specified parameters.
- *
- * @param params - The query parameters including object name, filter, pagination, ordering, and fields.
- * @returns The constructed GraphQL query string.
+ * Constructs a GraphQL query to fetch records for a given object.
+ * @param {GraphqlQueryParams} params - The parameters for the GraphQL query.
+ * @returns {string} - The constructed GraphQL query string.
  */
 export declare const FETCH_RECORDS_QUERY: ({ objectName, operationName, filter, first, offset, after, orderBy, fields, }: GraphqlQueryParams) => string;
 /**
- * Constructs a GraphQL mutation for deleting multiple objects.
- *
- * @param objectName - The name of the object to delete.
- * @param operationName - The graphql operation name.
- * @param records - The records to be deleted.
- * @returns The constructed GraphQL mutation string.
+ * Constructs a GraphQL mutation to delete objects.
+ * @param {GraphqlMutationParams} params - The parameters for the GraphQL mutation.
+ * @returns {string} - The constructed GraphQL mutation string.
  */
-export declare const DELETE_OBJECTS_MUTATION: ({ objectName, operationName, records }: GraphqlMurationParams) => string;
+export declare const DELETE_OBJECTS_MUTATION: ({ objectName, operationName, records }: GraphqlMutationParams) => string;
 /**
- * Constructs a GraphQL mutation for upserting (inserting/updating) multiple objects.
- *
- * @param objectName - The name of the object to upsert.
- * @param records - The records to be upserted.
- * @param operation - The operation type ("insert" or "update").
- * @returns The constructed GraphQL mutation string.
+ * Constructs a GraphQL mutation to insert, update, or upsert objects.
+ * @param {GraphqlMutationParams} params - The parameters for the GraphQL mutation.
+ * @returns {string} - The constructed GraphQL mutation string.
+ * @throws {Error} - If the operation type is invalid.
  */
-export declare const UPSERT_OBJECTS_MUTATION: ({ objectName, operationName, records, operation }: GraphqlMurationParams) => string;
+export declare const MUTATE_OBJECTS_MUTATION: ({ objectName, operationName, records, operation, keyField, }: GraphqlMutationParams) => string;

package/dist/services/graphql/queries.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.UPSERT_OBJECTS_MUTATION=exports.DELETE_OBJECTS_MUTATION=exports.FETCH_RECORDS_QUERY=void 0;const FETCH_RECORDS_QUERY=({objectName:e,operationName:n,filter:t,first:o=200,offset:E=0,after:T,orderBy:r,fields:s})=>`\n    query ${n} {\n      ${e}(${[t?`filter: "${t}"`:"",T?`after: "${T}"`:"",`first: ${o}`,E?`offset: ${E}`:"",r?`orderBy: "${r}"`:""].filter((e=>e)).join(", ")}) {\n        totalCount\n        pageInfo{\n          hasNextPage\n        }\n        edges {\n          cursor\n          offset\n          node {\n            ${s||"UID"}\n          }\n        }\n      }\n    }\n  `;exports.FETCH_RECORDS_QUERY=FETCH_RECORDS_QUERY;const DELETE_OBJECTS_MUTATION=({objectName:e,operationName:n,records:t})=>`\n  mutation ${n} {\n    schema {\n      ${t.map(((n,t)=>`alias${t+1}:delete${e}(UID: "${n.UID}")`)).join("\n    ")}\n    }\n  }`;exports.DELETE_OBJECTS_MUTATION=DELETE_OBJECTS_MUTATION;const UPSERT_OBJECTS_MUTATION=({objectName:e,operationName:n,records:t,operation:o})=>`\n  mutation ${n} {\n    schema {\n      ${t.map(((n,t)=>`\n        alias${t+1}:${o}${e}(input: {\n          ${Object.entries(n).map((([e,n])=>`${e}: ${"string"==typeof n?`"${n}"`:n}`)).join(", ")}\n        }) \n      `)).join("\n    ")}\n    }\n  }`;exports.UPSERT_OBJECTS_MUTATION=UPSERT_OBJECTS_MUTATION;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.MUTATE_OBJECTS_MUTATION=exports.DELETE_OBJECTS_MUTATION=exports.FETCH_RECORDS_QUERY=void 0;const FETCH_RECORDS_QUERY=({objectName:e,operationName:n,filter:t,first:o=200,offset:r=0,after:T,orderBy:E,fields:s})=>`\n    query ${n} {\n      ${e}(${[t?`filter: "${t}"`:"",T?`after: "${T}"`:"",`first: ${o}`,r?`offset: ${r}`:"",E?`orderBy: "${E}"`:""].filter((e=>e)).join(", ")}) {\n        totalCount\n        pageInfo{\n          hasNextPage\n        }\n        edges {\n          cursor\n          offset\n          node {\n            ${s||"UID"}\n          }\n        }\n      }\n    }\n  `;exports.FETCH_RECORDS_QUERY=FETCH_RECORDS_QUERY;const DELETE_OBJECTS_MUTATION=({objectName:e,operationName:n,records:t})=>`\n  mutation ${n} {\n    schema {\n      ${t.map(((n,t)=>`alias${t+1}:delete${e}(UID: "${n.UID}")`)).join("\n    ")}\n    }\n  }`;exports.DELETE_OBJECTS_MUTATION=DELETE_OBJECTS_MUTATION;const MUTATE_OBJECTS_MUTATION=({objectName:e,operationName:n,records:t,operation:o,keyField:r})=>{let T;return T="upsert"===o?t.map(((n,t)=>`\n          alias${t+1}:upsert${e}(\n            keyField: "${r||"UID"}",\n            input: {\n              ${Object.entries(n).map((([e,n])=>`${e}: ${"string"==typeof n?`"${n}"`:n}`)).join(", ")}\n            }\n          )\n        `)).join("\n    "):t.map(((n,t)=>`\n          alias${t+1}:${o}${e}(\n            input: {\n              ${Object.entries(n).map((([e,n])=>`${e}: ${"string"==typeof n?`"${n}"`:n}`)).join(", ")}\n            }\n          )\n        `)).join("\n    "),`\n    mutation ${n} {\n      schema {\n        ${T}\n      }\n    }\n  `};exports.MUTATE_OBJECTS_MUTATION=MUTATE_OBJECTS_MUTATION;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skedulo/pulse-solution-services",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "description": "A collection of services and utilities to support solution development on the Pulse platform.",
   "author": "Skedulo",
   "license": "MIT",