@skedulo/pulse-solution-services 0.0.7 → 0.0.8

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 // Generated by dts-bundle-generator v9.5.1
 
+import { z } from 'zod';
+
 /**
  * Interface representing the structure of metadata for an object.
  */
@@ -50,40 +52,49 @@ export interface PicklistValue {
 	active: boolean;
 	defaultValue: boolean;
 }
-/**
- * Interface defining the base configuration for API clients.
- */
 export interface BaseConfig {
 	apiServer: string;
 	apiToken: string;
 	internalApiToken?: string;
 }
+declare class ExecutionOptions {
+	/**
+	 * Identifies the origin of the request (e.g., the system, application, or project that initiated the call).
+	 * Helps in tracking and debugging requests across different systems.
+	 */
+	requestSource?: string;
+	/**
+	 * Identifies the client service or Lambda function making the request.
+	 * Useful for debugging and log filtering to trace which service handled the request.
+	 */
+	userAgent?: string;
+	/**
+	 * Creates an instance of ExecutionOptions.
+	 * Allows initializing with partial values for flexibility.
+	 *
+	 * @param initialValues - Partial execution options for initialization.
+	 */
+	constructor(initialValues?: Partial<ExecutionOptions>);
+}
+export interface RequestParams {
+	method?: string;
+	endpoint: string;
+	body?: object;
+	headers?: Record<string, string>;
+	queryParams?: Record<string, string>;
+}
 /**
  * Base client for making API requests with standardized error handling.
  * Provides methods for setting up headers and performing API requests using fetch.
  */
 export declare class BaseClient {
 	protected config: BaseConfig;
+	protected executionOptions: Partial<ExecutionOptions>;
 	/**
 	 * Creates an instance of BaseClient.
 	 * @param {BaseConfig} config - The configuration object containing API server and token.
 	 */
-	constructor(config: BaseConfig);
-	/**
-	 * Constructs the headers for API requests.
-	 * @returns {Record<string, string>} - The headers including authorization and content type.
-	 */
-	protected getHeaders(): {
-		Authorization: string;
-		"Content-Type": string;
-	};
-	/**
-	 * Builds a URL with query parameters.
-	 * @param {string} endpoint - The API endpoint.
-	 * @param {Record<string, string>} [queryParams] - Optional query parameters.
-	 * @returns {string} - The full URL with query parameters.
-	 */
-	private buildUrl;
+	constructor(config: BaseConfig, executionOptions?: Partial<ExecutionOptions>);
 	/**
 	 * Performs an API request with standardized error handling using fetch.
 	 * @template T
@@ -96,13 +107,19 @@ export declare class BaseClient {
 	 * @returns {Promise<T>} - The parsed response data.
 	 * @throws {Error} - If the request fails or the response is not OK.
 	 */
-	protected performRequest<T = any>({ method, endpoint, headers, body, queryParams, }: {
-		method?: string;
-		endpoint: string;
-		body?: object;
-		headers?: Record<string, string>;
-		queryParams?: Record<string, string>;
-	}): Promise<T>;
+	protected performRequest<T = any>({ method, endpoint, headers, body, queryParams }: RequestParams, executionOptions?: Partial<ExecutionOptions>): Promise<T>;
+	/**
+	 * Constructs the headers for API requests.
+	 * @returns {Record<string, string>} - The headers including authorization and content type.
+	 */
+	protected getHeaders(executionOptions: Partial<ExecutionOptions>): Record<string, string>;
+	/**
+	 * Builds a URL with query parameters.
+	 * @param {string} endpoint - The API endpoint.
+	 * @param {Record<string, string>} [queryParams] - Optional query parameters.
+	 * @returns {string} - The full URL with query parameters.
+	 */
+	private buildUrl;
 	/**
 	 * Handles exceptions encountered during API requests.
 	 * @param {any} error - The error to handle.
@@ -243,67 +260,6 @@ export declare class ConfigVarClient extends BaseClient {
 	 */
 	delete(key: string): Promise<string>;
 }
-export interface HasId {
-	UID?: string;
-	[key: string]: any;
-}
-export interface GraphQlResponse<T = any> {
-	data: T;
-	errors?: object[];
-}
-export interface FetchRecordsQueryParams {
-	objectName: string;
-	first?: number;
-	offset?: number;
-	orderBy?: string;
-	filter?: string;
-	after?: string;
-	fields?: string;
-}
-export interface QueryResult {
-	records: HasId[];
-	totalCount: number;
-	pageInfo: any;
-	endCursor: string;
-	endOffset: number;
-}
-export interface MutationResult {
-	data: {
-		schema: {
-			[alias: string]: string;
-		};
-	};
-}
-/**
- * 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.
-	 * @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): Promise<GraphQlResponse>;
-}
-/**
- * OrgPreferencesClient class to handle API requests related to organization preferences.
- * Extends BaseClient to perform API operations.
- */
-export declare class OrgPreferenceClient extends BaseClient {
-	/**
-	 * Fetches the organization preferences configuration.
-	 * @returns {Promise<Record<string, any>>} - A promise resolving to the sorted organization preferences.
-	 */
-	get(): Promise<Record<string, any>>;
-	/**
-	 * Deploys the organization preferences configuration.
-	 * @param {Record<string, any>} newConfig - The new configuration to be deployed.
-	 * @returns {Promise<Record<string, any>>} - A promise resolving when the configuration is successfully deployed.
-	 */
-	deploy(newConfig: Record<string, any>): Promise<Record<string, any>>;
-}
 export declare enum ArtifactType {
 	CUSTOM_OBJECT = "custom-object",
 	CUSTOM_FIELD = "custom-field",
@@ -335,6 +291,12 @@ export declare enum ConfigVariableStatus {
 	INACTIVE = "inactive",
 	EXPIRED = "expired"
 }
+export declare enum GraphqlOperations {
+	INSERT = "insert",
+	UPDATE = "update",
+	DELETE = "delete",
+	UPSERT = "upsert"
+}
 export declare enum HttpMethod {
 	GET = "GET",
 	POST = "POST",
@@ -408,6 +370,77 @@ export declare const TENANT_ENDPOINTS: {
 		readonly SIMPLE: "availability/simple";
 	};
 };
+export interface HasId {
+	UID?: string;
+	[key: string]: any;
+}
+export interface GraphQlResponse<T = any> {
+	data: T;
+	errors?: object[];
+}
+export interface GraphqlParams {
+	objectName: string;
+	operationName: string;
+}
+export interface GraphqlMurationParams extends GraphqlParams {
+	records: HasId[];
+	operation: GraphqlOperations;
+	bulkOperation?: boolean;
+}
+export interface GraphqlQueryParams extends GraphqlParams {
+	first?: number;
+	offset?: number;
+	orderBy?: string;
+	filter?: string;
+	after?: string;
+	fields?: string;
+	readOnly?: boolean;
+}
+export interface QueryResult {
+	records: HasId[];
+	totalCount: number;
+	pageInfo: any;
+	endCursor: string;
+	endOffset: number;
+}
+export interface MutationResult {
+	data: {
+		schema: {
+			[alias: string]: string;
+		};
+	};
+}
+/**
+ * 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.
+	 * @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>;
+}
+/**
+ * OrgPreferencesClient class to handle API requests related to organization preferences.
+ * Extends BaseClient to perform API operations.
+ */
+export declare class OrgPreferenceClient extends BaseClient {
+	/**
+	 * Fetches the organization preferences configuration.
+	 * @returns {Promise<Record<string, any>>} - A promise resolving to the sorted organization preferences.
+	 */
+	get(): Promise<Record<string, any>>;
+	/**
+	 * Deploys the organization preferences configuration.
+	 * @param {Record<string, any>} newConfig - The new configuration to be deployed.
+	 * @returns {Promise<Record<string, any>>} - A promise resolving when the configuration is successfully deployed.
+	 */
+	deploy(newConfig: Record<string, any>): Promise<Record<string, any>>;
+}
 export interface LatLng {
 	lat: number;
 	lng: number;
@@ -589,7 +622,7 @@ export type ArtifactParams = {
 declare class ArtifactClient extends BaseClient {
 	private artifactType;
 	private baseEndpoint;
-	constructor(config: any, artifactType: ArtifactType);
+	constructor(config: any, artifactType: ArtifactType, executionOptions?: Partial<ExecutionOptions>);
 	list<T>(): Promise<T[]>;
 	get<T>(params?: ArtifactParams): Promise<T>;
 	create<T>(params: ArtifactParams, artifactData: Partial<T>): Promise<T>;
@@ -943,43 +976,51 @@ export declare class GraphQLService {
 	constructor(client: GraphQLClient);
 	/**
 	 * Executes a GraphQL query to fetch records.
-	 * @param {FetchRecordsQueryParams} params - The query parameters.
+	 * @param {GraphqlQueryParams} params - The query parameters.
 	 * @returns {Promise<QueryResult>} - The query result including records, total count, page info, and cursors.
 	 */
-	query(params: FetchRecordsQueryParams): Promise<QueryResult>;
+	query(params: GraphqlQueryParams): Promise<QueryResult>;
 	/**
-	 * Deletes records from the GraphQL API.
+	 * 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.
 	 */
-	delete(objectName: string, records: HasId[]): Promise<any>;
+	mutate(params: GraphqlMurationParams): Promise<any>;
+	/**
+	 * Deletes records from the GraphQL API.
+	 */
+	delete(params: GraphqlMurationParams): Promise<any>;
 	/**
 	 * Updates records in the GraphQL API.
-	 * @param {string} objectName - The name of the object.
-	 * @param {HasId[]} records - The records to update.
-	 * @returns {Promise<any>} - The response from the update operation.
 	 */
-	update(objectName: string, records: HasId[]): Promise<any>;
+	update(params: GraphqlMurationParams): Promise<any>;
 	/**
 	 * Inserts records into the GraphQL API.
-	 * @param {string} objectName - The name of the object.
-	 * @param {HasId[]} records - The records to insert.
-	 * @returns {Promise<any>} - The response from the insert operation.
 	 */
-	insert(objectName: string, records: HasId[]): Promise<any>;
+	insert(params: GraphqlMurationParams): Promise<any>;
 	/**
 	 * Extracts job UIDs from a GraphQL mutation response.
 	 * @param {MutationResult} response - The response object.
 	 * @returns {string[]} - An array of job UIDs.
 	 */
 	extractJobUIDs(response: MutationResult): string[];
+	/**
+	 * Formats the object name to follow GraphQL naming conventions.
+	 * @param {string} objectName - The object name to format.
+	 * @returns {string} - The formatted object name.
+	 */
+	private getQueryName;
+	private getQueryHeaders;
+	private getMutationHeaders;
+	private getOperationHeader;
 }
 /**
  * A utility class for building GraphQL queries dynamically.
  */
 export declare class GraphQLQueryBuilder {
 	private objectName;
+	operationName: string;
 	private fields;
 	private filters;
 	private first?;
@@ -990,12 +1031,13 @@ export declare class GraphQLQueryBuilder {
 	private childQueries;
 	private isParent;
 	private graphqlService;
+	private queryParams;
 	/**
 	 * Creates an instance of GraphQLQueryBuilder.
-	 * @param {string} objectName - The name of the object being queried.
+	 * @param {string} graphqlQueryParams - The necessary parameters for the query.
 	 * @param {boolean} [isParent=false] - Indicates if this query is a parent query.
 	 */
-	constructor(objectName: string, isParent?: boolean);
+	constructor(queryParams: GraphqlQueryParams, isParent?: boolean);
 	/**
 	 * Sets the GraphQL service to use for executing the query.
 	 */
@@ -1039,7 +1081,7 @@ export declare class GraphQLQueryBuilder {
 	/**
 	 * Builds the GraphQL query parameters in a more structured format.
 	 */
-	build(): FetchRecordsQueryParams;
+	build(): GraphqlQueryParams;
 	/**
 	 * Executes the query using the GraphQL service, with improved error handling.
 	 */
@@ -1077,7 +1119,7 @@ declare class DataService {
 	constructor(graphqlService: GraphQLService);
 	getResources(param: ResourceQueryParam): Promise<Record<string, any>[]>;
 	getHolidays(regionIds: string[], startTime?: Date, endTime?: Date): Promise<Record<string, any>>;
-	newQueryBuilder(objectName: string): GraphQLQueryBuilder;
+	newQueryBuilder(params: GraphqlQueryParams): GraphQLQueryBuilder;
 }
 export declare class ResourceAvailabilityService {
 	private availabilityAPIClient;
@@ -1154,14 +1196,18 @@ export declare class ExecutionContext {
 	private baseConfig;
 	logger: typeof logger;
 	private services;
-	protected constructor(skedContext: any);
-	static fromContext(skedContext: any): ExecutionContext;
-	static fromCredentials(config: BaseConfig): ExecutionContext;
+	private _executionOptions;
+	protected constructor(skedContext: any, executionOptions?: Partial<ExecutionOptions>);
+	static fromContext(skedContext: any, executionOptions?: Partial<ExecutionOptions>): ExecutionContext;
+	static fromCredentials(config: BaseConfig, executionOptions?: Partial<ExecutionOptions>): ExecutionContext;
+	set executionOptions(executionOptions: Partial<ExecutionOptions>);
+	get executionOptions(): Partial<ExecutionOptions>;
 	/**
 	 * Generic method to retrieve or initialize a service.
 	 */
 	private getOrCreateService;
 	get configHelper(): ConfigHelper;
+	get baseClient(): BaseClient;
 	get graphqlClient(): GraphQLClient;
 	get graphqlService(): GraphQLService;
 	get metadataClient(): MetadataClient;
@@ -1180,10 +1226,11 @@ export declare class ExecutionContext {
 	get resourceAvailabilityService(): ResourceAvailabilityService;
 	get dataService(): DataService;
 	get resourceBuilder(): ResourceBuilder;
-	newQueryBuilder(objectName: string): GraphQLQueryBuilder;
+	newQueryBuilder(params: GraphqlQueryParams): GraphQLQueryBuilder;
 	newArtifactClient(artifactType: ArtifactType): ArtifactClient;
 	dispose(): void;
 }
+export declare const REQUEST_HEADERS: Record<string, string>;
 export declare const TenantObjects: {
 	Accounts: {
 		Name: string;
@@ -1297,6 +1344,91 @@ export declare class BatchOrchestrator {
 	protected updateJobStatus(): Promise<void>;
 	private isCompleted;
 }
+export declare enum PaginationStrategy {
+	CURSOR = "cursor",
+	OFFSET = "offset",
+	NONE = "none"
+}
+/**
+ * Default configuration values for `GraphBatchConfig`.
+ */
+export declare const DEFAULT_GRAPH_BATCH_CONFIG: GraphBatchConfig;
+declare const GraphBatchConfigSchema: z.ZodObject<{
+	strategy: z.ZodNativeEnum<typeof PaginationStrategy>;
+	batchSize: z.ZodDefault<z.ZodNumber>;
+	maxBatches: z.ZodDefault<z.ZodNumber>;
+	delaySeconds: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+	strategy: PaginationStrategy;
+	batchSize: number;
+	maxBatches: number;
+	delaySeconds: number;
+}, {
+	strategy: PaginationStrategy;
+	batchSize?: number | undefined;
+	maxBatches?: number | undefined;
+	delaySeconds?: number | undefined;
+}>;
+/**
+ * Configuration options for `GraphBatch`.
+ */
+export type GraphBatchConfig = z.infer<typeof GraphBatchConfigSchema>;
+/**
+ * Merges user-provided config with default values.
+ */
+export declare function initializeConfig(config: Partial<GraphBatchConfig> | undefined): GraphBatchConfig;
+/**
+ * Base class for batch processing with pagination support.
+ */
+export declare abstract class GraphBatch {
+	protected context: ExecutionContext;
+	protected config: GraphBatchConfig;
+	protected queryBuilder?: GraphQLQueryBuilder;
+	protected queryResult?: QueryResult;
+	private startTime;
+	constructor(context: ExecutionContext, config?: Partial<GraphBatchConfig>);
+	/**
+	 * Runs the batch process, handling pagination, execution, and accumulation of results.
+	 *
+	 * @returns The accumulated result of the batch process.
+	 */
+	run(): Promise<void>;
+	/**
+	 * Initializes the query builder. This method must be overridden in subclasses.
+	 *
+	 * @returns A configured GraphQL query builder.
+	 */
+	protected abstract start(): Promise<GraphQLQueryBuilder>;
+	/**
+	 * Processes a batch of records and accumulates the result.
+	 *
+	 * @param records The batch of records retrieved from the query.
+	 */
+	protected abstract execute(records: any[]): Promise<void>;
+	/**
+	 * Final cleanup or logging after the batch process completes.
+	 */
+	protected finish(): Promise<void>;
+	/**
+	 * Fetches the next page of data based on the pagination strategy.
+	 *
+	 * @returns The result of the query execution.
+	 */
+	protected fetchNextPage(): Promise<QueryResult>;
+	/**
+	 * Checks if the maximum number of batches has been reached.
+	 *
+	 * @param currentBatchCount The number of batches processed so far.
+	 * @returns `true` if the maximum limit is reached, otherwise `false`.
+	 */
+	protected isMaxBatchesReached(currentBatchCount: number): boolean;
+	/**
+	 * Delays execution for a specified time.
+	 *
+	 * @param ms The time in milliseconds to delay.
+	 */
+	protected delay(ms: number): Promise<void>;
+}
 export interface ResourceValidationOption {
 	checkAvailability: boolean;
 	checkConflict: boolean;

package/dist/interfaces/api-client.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});

package/dist/interfaces/index.js

@@ -1 +1 @@
-"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,r,t,i){void 0===i&&(i=t);var o=Object.getOwnPropertyDescriptor(r,t);o&&!("get"in o?!r.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return r[t]}}),Object.defineProperty(e,i,o)}:function(e,r,t,i){void 0===i&&(i=t),e[i]=r[t]}),__exportStar=this&&this.__exportStar||function(e,r){for(var t in e)"default"===t||Object.prototype.hasOwnProperty.call(r,t)||__createBinding(r,e,t)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("../core/tenant-entities"),exports),__exportStar(require("./availability"),exports),__exportStar(require("./config-template"),exports),__exportStar(require("./config-var"),exports),__exportStar(require("./geoservice-interfaces"),exports),__exportStar(require("./graphql"),exports),__exportStar(require("./metadata"),exports),__exportStar(require("./mobile-notification"),exports);
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,r,t,i){void 0===i&&(i=t);var o=Object.getOwnPropertyDescriptor(r,t);o&&!("get"in o?!r.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return r[t]}}),Object.defineProperty(e,i,o)}:function(e,r,t,i){void 0===i&&(i=t),e[i]=r[t]}),__exportStar=this&&this.__exportStar||function(e,r){for(var t in e)"default"===t||Object.prototype.hasOwnProperty.call(r,t)||__createBinding(r,e,t)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("../core/tenant-entities"),exports),__exportStar(require("./api-client"),exports),__exportStar(require("./availability"),exports),__exportStar(require("./config-template"),exports),__exportStar(require("./config-var"),exports),__exportStar(require("./geoservice-interfaces"),exports),__exportStar(require("./graphql"),exports),__exportStar(require("./metadata"),exports),__exportStar(require("./mobile-notification"),exports);

package/dist/services/batch-processor/fetching-strategies/cursor-based-fetching-strategy.js

@@ -1 +1 @@
-"use strict";var __awaiter=this&&this.__awaiter||function(t,e,o,r){return new(o||(o=Promise))((function(a,n){function i(t){try{s(r.next(t))}catch(t){n(t)}}function c(t){try{s(r.throw(t))}catch(t){n(t)}}function s(t){var e;t.done?a(t.value):(e=t.value,e instanceof o?e:new o((function(t){t(e)}))).then(i,c)}s((r=r.apply(t,e||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.CursorBasedFetchingStrategy=void 0,exports.CursorBasedFetchingStrategy={execute(t){return __awaiter(this,void 0,void 0,(function*(){var e,o,r,a,n,i;const c=t.contextData.job.BatchSize||200,s=(t.contextData.job.Fields||"UID").split(",").map((t=>t.trim()));s.includes("UID")||s.push("UID");t.contextData.job.ObjectName,t.contextData.job.OrderBy,null===(o=null===(e=t.contextData.batchState)||void 0===e?void 0:e.processor)||void 0===o||o.cursor,t.contextData.job.FilterCondition,s.join("\n");const u=t.newQueryBuilder(t.contextData.job.objectName);u.withFields(s).withLimit(c).withOrderBy(t.contextData.job.OrderBy).withFilter(t.contextData.job.FilterCondition);const d=yield t.graphqlService.query(u.build()),l=d.records,h=d.endCursor;return null===(n=null===(a=null===(r=t.contextData.batchState)||void 0===r?void 0:r.processor)||void 0===a?void 0:a.allCursors)||void 0===n||n.push(h),(null===(i=t.contextData.batchState)||void 0===i?void 0:i.processor)&&(t.contextData.batchState.processor.cursor=h),l}))}};
+"use strict";var __awaiter=this&&this.__awaiter||function(t,e,o,r){return new(o||(o=Promise))((function(a,i){function n(t){try{s(r.next(t))}catch(t){i(t)}}function c(t){try{s(r.throw(t))}catch(t){i(t)}}function s(t){var e;t.done?a(t.value):(e=t.value,e instanceof o?e:new o((function(t){t(e)}))).then(n,c)}s((r=r.apply(t,e||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.CursorBasedFetchingStrategy=void 0,exports.CursorBasedFetchingStrategy={execute(t){return __awaiter(this,void 0,void 0,(function*(){var e,o,r,a,i,n;const c=t.contextData.job.BatchSize||200,s=(t.contextData.job.Fields||"UID").split(",").map((t=>t.trim()));s.includes("UID")||s.push("UID");let u={objectName:t.contextData.job.ObjectName,operationName:t.contextData.job.ObjectName,first:c,orderBy:t.contextData.job.OrderBy,after:null===(o=null===(e=t.contextData.batchState)||void 0===e?void 0:e.processor)||void 0===o?void 0:o.cursor,filter:t.contextData.job.FilterCondition,fields:s.join("\n")};const d=t.newQueryBuilder(u);d.withFields(s).withLimit(c).withOrderBy(t.contextData.job.OrderBy).withFilter(t.contextData.job.FilterCondition);const l=yield t.graphqlService.query(d.build()),h=l.records,v=l.endCursor;return null===(i=null===(a=null===(r=t.contextData.batchState)||void 0===r?void 0:r.processor)||void 0===a?void 0:a.allCursors)||void 0===i||i.push(v),(null===(n=t.contextData.batchState)||void 0===n?void 0:n.processor)&&(t.contextData.batchState.processor.cursor=v),h}))}};

package/dist/services/batch-processor/fetching-strategies/date-based-fetching-strategy.js

@@ -1 +1 @@
-"use strict";var __awaiter=this&&this.__awaiter||function(e,t,i,r){return new(i||(i=Promise))((function(n,a){function o(e){try{s(r.next(e))}catch(e){a(e)}}function c(e){try{s(r.throw(e))}catch(e){a(e)}}function s(e){var t;e.done?n(e.value):(t=e.value,t instanceof i?t:new i((function(e){e(t)}))).then(o,c)}s((r=r.apply(e,t||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.DateBasedFetchingStrategy=void 0,exports.DateBasedFetchingStrategy={execute(e){return __awaiter(this,void 0,void 0,(function*(){const t=e.contextData.job;let i=`LastModifiedDate <= ${t.CreatedDate} `;t.FilterCondition&&(i+=` AND ${t.FilterCondition}`);const r=t.OrderBy||"CreatedDate ASC",n=t.BatchSize||10,a=(t.Fields||"UID").split(",").map((e=>e.trim()));return(yield e.graphqlService.query({objectName:t.ObjectName,first:n,filter:i,orderBy:r,fields:a.join("\n")})).records}))}};
+"use strict";var __awaiter=this&&this.__awaiter||function(e,t,i,r){return new(i||(i=Promise))((function(n,a){function o(e){try{s(r.next(e))}catch(e){a(e)}}function c(e){try{s(r.throw(e))}catch(e){a(e)}}function s(e){var t;e.done?n(e.value):(t=e.value,t instanceof i?t:new i((function(e){e(t)}))).then(o,c)}s((r=r.apply(e,t||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.DateBasedFetchingStrategy=void 0,exports.DateBasedFetchingStrategy={execute(e){return __awaiter(this,void 0,void 0,(function*(){const t=e.contextData.job;let i=`LastModifiedDate <= ${t.CreatedDate} `;t.FilterCondition&&(i+=` AND ${t.FilterCondition}`);const r=t.OrderBy||"CreatedDate ASC",n=t.BatchSize||10,a=(t.Fields||"UID").split(",").map((e=>e.trim()));return(yield e.graphqlService.query({objectName:t.ObjectName,operationName:t.ObjectName,first:n,filter:i,orderBy:r,fields:a.join("\n")})).records}))}};

package/dist/services/graph-batch/graph-batch-config.d.ts

@@ -0,0 +1,34 @@
+import { z } from "zod";
+import { PaginationStrategy } from "./pagination-strategy";
+/**
+ * Default configuration values for `GraphBatchConfig`.
+ */
+export declare const DEFAULT_GRAPH_BATCH_CONFIG: GraphBatchConfig;
+/**
+ * Schema validation using `zod`
+ */
+declare const GraphBatchConfigSchema: z.ZodObject<{
+    strategy: z.ZodNativeEnum<typeof PaginationStrategy>;
+    batchSize: z.ZodDefault<z.ZodNumber>;
+    maxBatches: z.ZodDefault<z.ZodNumber>;
+    delaySeconds: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    strategy: PaginationStrategy;
+    batchSize: number;
+    maxBatches: number;
+    delaySeconds: number;
+}, {
+    strategy: PaginationStrategy;
+    batchSize?: number | undefined;
+    maxBatches?: number | undefined;
+    delaySeconds?: number | undefined;
+}>;
+/**
+ * Configuration options for `GraphBatch`.
+ */
+export type GraphBatchConfig = z.infer<typeof GraphBatchConfigSchema>;
+/**
+ * Merges user-provided config with default values.
+ */
+export declare function initializeConfig(config: Partial<GraphBatchConfig> | undefined): GraphBatchConfig;
+export {};

package/dist/services/graph-batch/graph-batch-config.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.DEFAULT_GRAPH_BATCH_CONFIG=void 0,exports.initializeConfig=initializeConfig;const zod_1=require("zod"),pagination_strategy_1=require("./pagination-strategy");exports.DEFAULT_GRAPH_BATCH_CONFIG={strategy:pagination_strategy_1.PaginationStrategy.NONE,batchSize:200,maxBatches:100,delaySeconds:0};const GraphBatchConfigSchema=zod_1.z.object({strategy:zod_1.z.nativeEnum(pagination_strategy_1.PaginationStrategy),batchSize:zod_1.z.number().min(1).max(200).default(200),maxBatches:zod_1.z.number().min(1).max(500).default(100),delaySeconds:zod_1.z.number().min(0).max(15).default(0)});function initializeConfig(t){return GraphBatchConfigSchema.parse(Object.assign(Object.assign({},exports.DEFAULT_GRAPH_BATCH_CONFIG),t))}

package/dist/services/graph-batch/graph-batch.d.ts

@@ -0,0 +1,56 @@
+import { ExecutionContext } from "../../core";
+import { QueryResult } from "../../interfaces";
+import { GraphQLQueryBuilder } from "../graphql";
+import { GraphBatchConfig } from "./graph-batch-config";
+/**
+ * Base class for batch processing with pagination support.
+ */
+export declare abstract class GraphBatch {
+    protected context: ExecutionContext;
+    protected config: GraphBatchConfig;
+    protected queryBuilder?: GraphQLQueryBuilder;
+    protected queryResult?: QueryResult;
+    private startTime;
+    constructor(context: ExecutionContext, config?: Partial<GraphBatchConfig>);
+    /**
+     * Runs the batch process, handling pagination, execution, and accumulation of results.
+     *
+     * @returns The accumulated result of the batch process.
+     */
+    run(): Promise<void>;
+    /**
+     * Initializes the query builder. This method must be overridden in subclasses.
+     *
+     * @returns A configured GraphQL query builder.
+     */
+    protected abstract start(): Promise<GraphQLQueryBuilder>;
+    /**
+     * Processes a batch of records and accumulates the result.
+     *
+     * @param records The batch of records retrieved from the query.
+     */
+    protected abstract execute(records: any[]): Promise<void>;
+    /**
+     * Final cleanup or logging after the batch process completes.
+     */
+    protected finish(): Promise<void>;
+    /**
+     * Fetches the next page of data based on the pagination strategy.
+     *
+     * @returns The result of the query execution.
+     */
+    protected fetchNextPage(): Promise<QueryResult>;
+    /**
+     * Checks if the maximum number of batches has been reached.
+     *
+     * @param currentBatchCount The number of batches processed so far.
+     * @returns `true` if the maximum limit is reached, otherwise `false`.
+     */
+    protected isMaxBatchesReached(currentBatchCount: number): boolean;
+    /**
+     * Delays execution for a specified time.
+     *
+     * @param ms The time in milliseconds to delay.
+     */
+    protected delay(ms: number): Promise<void>;
+}

package/dist/services/graph-batch/graph-batch.js

@@ -0,0 +1 @@
+"use strict";var __awaiter=this&&this.__awaiter||function(t,e,i,r){return new(i||(i=Promise))((function(a,s){function n(t){try{o(r.next(t))}catch(t){s(t)}}function h(t){try{o(r.throw(t))}catch(t){s(t)}}function o(t){var e;t.done?a(t.value):(e=t.value,e instanceof i?e:new i((function(t){t(e)}))).then(n,h)}o((r=r.apply(t,e||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.GraphBatch=void 0;const graph_batch_config_1=require("./graph-batch-config"),pagination_strategy_1=require("./pagination-strategy");class GraphBatch{constructor(t,e){this.startTime=new Date,this.context=t,this.config=(0,graph_batch_config_1.initializeConfig)(e),this.startTime=new Date}run(){return __awaiter(this,void 0,void 0,(function*(){var t,e;if(this.queryBuilder=yield this.start(),!this.queryBuilder)throw new Error("Query builder was not defined in start().");this.queryBuilder.withLimit(this.config.batchSize);let i=0,r=!0;for(;r&&!this.isMaxBatchesReached(i)&&(this.queryResult=yield this.fetchNextPage(),this.queryResult.records&&0!==this.queryResult.records.length);)yield this.execute(this.queryResult.records),i++,r=null!==(e=null===(t=this.queryResult.pageInfo)||void 0===t?void 0:t.hasNextPage)&&void 0!==e&&e;yield Promise.all([]),yield this.finish()}))}finish(){return __awaiter(this,void 0,void 0,(function*(){this.context.logger.info("Batch process completed.")}))}fetchNextPage(){return __awaiter(this,void 0,void 0,(function*(){var t,e,i;switch(this.config.strategy){case pagination_strategy_1.PaginationStrategy.OFFSET:this.queryResult&&(null===(t=this.queryBuilder)||void 0===t||t.withOffset(this.queryResult.endOffset+1));break;case pagination_strategy_1.PaginationStrategy.CURSOR:this.queryResult&&(null===(e=this.queryBuilder)||void 0===e||e.withCursor(this.queryResult.endCursor));break;case pagination_strategy_1.PaginationStrategy.NONE:default:null===(i=this.queryBuilder)||void 0===i||i.withFilter(`LastModifiedDate < ${this.startTime.toISOString()}`)}return this.queryBuilder.execute()}))}isMaxBatchesReached(t){return!!this.config.maxBatches&&t>=this.config.maxBatches}delay(t){return __awaiter(this,void 0,void 0,(function*(){return new Promise((e=>setTimeout(e,t)))}))}}exports.GraphBatch=GraphBatch;

package/dist/services/graph-batch/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./graph-batch";
+export * from "./graph-batch-config";
+export * from "./pagination-strategy";

package/dist/services/graph-batch/index.js

@@ -0,0 +1 @@
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,i){void 0===i&&(i=r);var o=Object.getOwnPropertyDescriptor(t,r);o&&!("get"in o?!t.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,i,o)}:function(e,t,r,i){void 0===i&&(i=r),e[i]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./graph-batch"),exports),__exportStar(require("./graph-batch-config"),exports),__exportStar(require("./pagination-strategy"),exports);

package/dist/services/graph-batch/pagination-strategy.d.ts

@@ -0,0 +1,5 @@
+export declare enum PaginationStrategy {
+    CURSOR = "cursor",
+    OFFSET = "offset",
+    NONE = "none"
+}

package/dist/services/graph-batch/pagination-strategy.js

@@ -0,0 +1 @@
+"use strict";var PaginationStrategy;Object.defineProperty(exports,"__esModule",{value:!0}),exports.PaginationStrategy=void 0,function(t){t.CURSOR="cursor",t.OFFSET="offset",t.NONE="none"}(PaginationStrategy||(exports.PaginationStrategy=PaginationStrategy={}));