@flosum/salesforce 1.9.2

package/dist/typings/classes/query-builder.d.ts

@@ -0,0 +1,82 @@
+import { SortDirection } from '../enums/query.enums';
+import ClauseBuilder from './clause-builder';
+declare type OrderItem = [string, SortDirection];
+declare type QueryBuilderOptions = {
+    throwOnSizeExceeded?: boolean;
+    maxSize?: number;
+};
+/**
+ * QueryBuilder is an util class which builds simple queries for Salesforce
+ * @example
+ * const builder = new QueryBuilder()
+ *  .select('Id', 'Name')
+ *  .from('Account')
+ *  .where('Id >= :startId', { startId: '00PJ000000A78cnMAB' })
+ *  .andWhere('Name = 'John')
+ *  .limit(2000)
+ *  .orderBy(['Id', SortDirection.ASC])
+ *
+ * const query = builder.build();
+ * // SELECT Id, Name FROM Account WHERE Id >= '00PJ000000A78cnMAB' AND Name = 'John' ORDER BY Id ASC LIMIT 2000
+ */
+export default class QueryBuilder {
+    private readonly _throwOnSizeExceeded;
+    private readonly _maxSize;
+    private _fields;
+    private _object;
+    private _orders;
+    private _limit;
+    private _clauseBuilder;
+    get maxSize(): number;
+    constructor({ throwOnSizeExceeded, maxSize }?: QueryBuilderOptions);
+    private buildOrders;
+    private buildBaseSelect;
+    private buildLimit;
+    hasLimit(): boolean;
+    hasOrders(): boolean;
+    /**
+     * Specify field to select
+     * @param fields a list of fields separated by comma
+     * @example
+     * builder.select('Id', 'Name')
+     */
+    select(...fields: string[]): QueryBuilder;
+    /**
+     * Specify object (table) to select from
+     * @param object object name
+     * @example
+     * builder.from('Account')
+     */
+    from(object: string): QueryBuilder;
+    /**
+     * Specify a limit for records to retrieve
+     * @param limit number of records to retrieve
+     * @example
+     * builder.limit(2000)
+     */
+    limit(limit: number): QueryBuilder;
+    /**
+     * Specify an order for records to retrieve
+     * @param orders list of orders
+     * @example
+     * builder.order(['Id', SortDirection.ASC], ['Name', SortDirection.DESC])
+     */
+    order(...orders: OrderItem[]): QueryBuilder;
+    where(clause: ClauseBuilder): QueryBuilder;
+    where(input: string, parameters?: Record<string, any>): QueryBuilder;
+    orWhere(clause: ClauseBuilder): QueryBuilder;
+    orWhere(input: string, parameters?: Record<string, any>): QueryBuilder;
+    andWhere(clause: ClauseBuilder): QueryBuilder;
+    andWhere(input: string, parameters?: Record<string, any>): QueryBuilder;
+    copy(): QueryBuilder;
+    clearClause(): QueryBuilder;
+    /**
+     * Build an actual query from specified properties
+     * @param encodeUri if true then returns encoded string to be used in requests
+     * @example
+     * builder.select('Id').from('Account').build() // SELECT Id FROM Account
+     */
+    build(encodeUri?: boolean): string;
+    private buildClauses;
+}
+export {};

package/dist/typings/classes/retrieve-binary/apex-rest-retrieve-binary.d.ts

@@ -0,0 +1,8 @@
+import BaseRetrieveBinary from './base-retrieve-binary';
+import { RetrieveBinaryRequestApexRest, RetrieveBinaryResult } from '../../interfaces/retrieve-binary.interfaces';
+export default class ApexRestRetrieveBinary extends BaseRetrieveBinary {
+    private readonly endpoint;
+    constructor({ objectName, fields, instance, endpoint }: RetrieveBinaryRequestApexRest);
+    execute(recordsId: string[]): Promise<RetrieveBinaryResult[]>;
+    private convertBase64toStreams;
+}

package/dist/typings/classes/retrieve-binary/base-retrieve-binary.d.ts

@@ -0,0 +1,9 @@
+import { AxiosInstance } from 'axios';
+import { RetrieveBinaryResult } from '../../interfaces/retrieve-binary.interfaces';
+export default abstract class BaseRetrieveBinary {
+    protected readonly objectName: string;
+    protected readonly fields: string[];
+    protected readonly instance: AxiosInstance;
+    constructor(objectName: string, fields: string[], instance: AxiosInstance);
+    abstract execute(recordsId: string[]): Promise<RetrieveBinaryResult[]>;
+}

package/dist/typings/classes/retrieve-binary/rest-retrieve-binary.d.ts

@@ -0,0 +1,7 @@
+import BaseRetrieveBinary from './base-retrieve-binary';
+import { RetrieveBinaryRequestRest, RetrieveBinaryResult } from '../../interfaces/retrieve-binary.interfaces';
+export default class RestRetrieveBinary extends BaseRetrieveBinary {
+    private readonly api;
+    constructor({ objectName, fields, instance, api }: RetrieveBinaryRequestRest);
+    execute([recordId]: string[]): Promise<RetrieveBinaryResult[]>;
+}

package/dist/typings/classes/retrieve-data/base-retrieve-data.d.ts

@@ -0,0 +1,12 @@
+import { AxiosInstance } from 'axios';
+import QueryBuilder from '../query-builder';
+export default abstract class BaseRetrieveData<T> {
+    protected readonly instance: AxiosInstance;
+    protected readonly queryBuilder: QueryBuilder;
+    protected isDone: boolean;
+    protected numberRetrievedRecords: number;
+    getIsDone(): boolean;
+    protected constructor(instance: AxiosInstance, queryBuilder: QueryBuilder);
+    abstract execute(): Promise<T>;
+    protected isExecutable(): void;
+}

package/dist/typings/classes/retrieve-data/bulk1-custom-pk-retrieve-data.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="node" />
+import BaseRetrieveData from './base-retrieve-data';
+import { RetrieveRequestBulk1CustomPk } from '../../interfaces/retrieve.interfaces';
+import * as stream from 'stream';
+export default class Bulk1CustomPkRetrieveData extends BaseRetrieveData<stream.Readable | null> {
+    private readonly objectName;
+    private readonly api;
+    private readonly pollInterval;
+    private readonly queryChunkSize;
+    private readonly lastRetrievedIndex?;
+    private jobId;
+    private chunks;
+    private currentBatchId;
+    private batchesIds;
+    private batchResultIds;
+    private get requestConfig();
+    constructor({ instance, api, pollInterval, queryBuilder, objectName, queryChunkSize, indexDetails, }: RetrieveRequestBulk1CustomPk);
+    execute(): Promise<stream.Readable | null>;
+    closeJob(): Promise<void>;
+    private getResultIds;
+    private createBatches;
+    private waitCompletionBatch;
+    private createJob;
+    private fetchId;
+    private init;
+}

package/dist/typings/classes/retrieve-data/bulk1-pk-retrieve-data.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="node" />
+import BaseRetrieveData from './base-retrieve-data';
+import { RetrieveRequestBulk1PK } from '../../interfaces/retrieve.interfaces';
+import stream from 'stream';
+export default class Bulk1PkRetrieveData extends BaseRetrieveData<stream.Readable | null> {
+    private readonly objectName;
+    private readonly api;
+    private readonly pollInterval;
+    private jobId;
+    private baseBatchId;
+    private currentBatchId;
+    private batchesDetail;
+    private batchResultIds;
+    private lastUpdateBatchesDetail;
+    private get requestConfig();
+    constructor({ instance, api, pollInterval, queryBuilder, objectName }: RetrieveRequestBulk1PK);
+    execute(): Promise<stream.Readable | null>;
+    closeJob(): Promise<void>;
+    private updateCurrentBatchId;
+    private updateBatchesDetail;
+    private updateBatchResultIds;
+    private init;
+    private createBatch;
+    private getAllBatchesDetail;
+    private getBatchResult;
+    private waitCompletionBaseBatch;
+    private createJob;
+}

package/dist/typings/classes/retrieve-data/bulk1-pk-retrieve-data.fixtures.d.ts

@@ -0,0 +1,38 @@
+export declare const jobDetails: {
+    apexProcessingTime: number;
+    apiActiveProcessingTime: number;
+    apiVersion: number;
+    assignmentRuleId: any;
+    concurrencyMode: string;
+    contentType: string;
+    createdById: string;
+    createdDate: string;
+    externalIdFieldName: any;
+    fastPathEnabled: boolean;
+    id: string;
+    numberBatchesCompleted: number;
+    numberBatchesFailed: number;
+    numberBatchesInProgress: number;
+    numberBatchesQueued: number;
+    numberBatchesTotal: number;
+    numberRecordsFailed: number;
+    numberRecordsProcessed: number;
+    numberRetries: number;
+    object: string;
+    operation: string;
+    state: string;
+    systemModstamp: string;
+    totalProcessingTime: number;
+};
+export declare const baseBatchDetailsQueued = "\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<batchInfo\n   xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">\n    <id>751J0000006JoIWIA0</id>\n    <jobId>750J0000006VqfSIAS</jobId>\n    <state>Queued</state>\n    <createdDate>2022-07-17T14:59:59.000Z</createdDate>\n    <systemModstamp>2022-07-17T14:59:59.000Z</systemModstamp>\n    <numberRecordsProcessed>0</numberRecordsProcessed>\n    <numberRecordsFailed>0</numberRecordsFailed>\n    <totalProcessingTime>0</totalProcessingTime>\n    <apiActiveProcessingTime>0</apiActiveProcessingTime>\n    <apexProcessingTime>0</apexProcessingTime>\n</batchInfo>";
+export declare const baseBatchDetailsInProgress = "\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<batchInfo\n   xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">\n    <id>751J0000006JoIWIA0</id>\n    <jobId>750J0000006VqfSIAS</jobId>\n    <state>InProgress</state>\n    <createdDate>2022-07-17T14:59:59.000Z</createdDate>\n    <systemModstamp>2022-07-17T14:59:59.000Z</systemModstamp>\n    <numberRecordsProcessed>0</numberRecordsProcessed>\n    <numberRecordsFailed>0</numberRecordsFailed>\n    <totalProcessingTime>0</totalProcessingTime>\n    <apiActiveProcessingTime>0</apiActiveProcessingTime>\n    <apexProcessingTime>0</apexProcessingTime>\n</batchInfo>";
+export declare const baseBatchDetailsNotProcessed = "\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<batchInfo\n   xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">\n    <id>751J0000006JoIWIA0</id>\n    <jobId>750J0000006VqfSIAS</jobId>\n    <state>NotProcessed</state>\n    <createdDate>2022-07-17T14:59:59.000Z</createdDate>\n    <systemModstamp>2022-07-17T14:59:59.000Z</systemModstamp>\n    <numberRecordsProcessed>0</numberRecordsProcessed>\n    <numberRecordsFailed>0</numberRecordsFailed>\n    <totalProcessingTime>0</totalProcessingTime>\n    <apiActiveProcessingTime>0</apiActiveProcessingTime>\n    <apexProcessingTime>0</apexProcessingTime>\n</batchInfo>";
+export declare const baseBatchDetailsError = "\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<batchInfo\n   xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">\n    <id>751J0000006JoIWIA0</id>\n    <jobId>750J0000006VqfSIAS</jobId>\n    <state>Failed</state>\n    <stateMessage>InvalidBatch : Failed to process query: MALFORMED_QUERY: unexpected token: BY</stateMessage>\n    <createdDate>2022-07-17T14:59:59.000Z</createdDate>\n    <systemModstamp>2022-07-17T14:59:59.000Z</systemModstamp>\n    <numberRecordsProcessed>0</numberRecordsProcessed>\n    <numberRecordsFailed>0</numberRecordsFailed>\n    <totalProcessingTime>0</totalProcessingTime>\n    <apiActiveProcessingTime>0</apiActiveProcessingTime>\n    <apexProcessingTime>0</apexProcessingTime>\n</batchInfo>\n";
+export declare const batchesDetailsWithInProgress = "\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<batchInfoList\n   xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">\n    <batchInfo>\n        <id>751J0000006JoH5IAK</id>\n        <jobId>750J0000006VqfSIAS</jobId>\n        <state>InProgress</state>\n        <createdDate>2022-07-17T15:00:01.000Z</createdDate>\n        <systemModstamp>2022-07-17T15:00:16.000Z</systemModstamp>\n        <numberRecordsProcessed>100475</numberRecordsProcessed>\n        <numberRecordsFailed>0</numberRecordsFailed>\n        <totalProcessingTime>0</totalProcessingTime>\n        <apiActiveProcessingTime>0</apiActiveProcessingTime>\n        <apexProcessingTime>0</apexProcessingTime>\n    </batchInfo>\n    <batchInfo>\n        <id>751J0000006JoH6IAK</id>\n        <jobId>750J0000006VqfSIAS</jobId>\n        <state>Completed</state>\n        <createdDate>2022-07-17T15:00:01.000Z</createdDate>\n        <systemModstamp>2022-07-17T15:00:19.000Z</systemModstamp>\n        <numberRecordsProcessed>104774</numberRecordsProcessed>\n        <numberRecordsFailed>0</numberRecordsFailed>\n        <totalProcessingTime>0</totalProcessingTime>\n        <apiActiveProcessingTime>0</apiActiveProcessingTime>\n        <apexProcessingTime>0</apexProcessingTime>\n    </batchInfo>\n    <batchInfo>\n        <id>751J0000006JoIWIA0</id>\n        <jobId>750J0000006VqfSIAS</jobId>\n        <state>NotProcessed</state>\n        <createdDate>2022-07-17T14:59:59.000Z</createdDate>\n        <systemModstamp>2022-07-17T15:00:02.000Z</systemModstamp>\n        <numberRecordsProcessed>0</numberRecordsProcessed>\n        <numberRecordsFailed>0</numberRecordsFailed>\n        <totalProcessingTime>0</totalProcessingTime>\n        <apiActiveProcessingTime>0</apiActiveProcessingTime>\n        <apexProcessingTime>0</apexProcessingTime>\n    </batchInfo>\n</batchInfoList>   \n";
+export declare const batchesDetailsWithError = "\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<batchInfoList\n   xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">\n    <batchInfo>\n        <id>751J0000006JoH5IAK</id>\n        <jobId>750J0000006VqfSIAS</jobId>\n        <state>Failed</state>\n        <stateMessage>InvalidBatch : Failed to process query: MALFORMED_QUERY: unexpected token: 'where'</stateMessage>\n        <createdDate>2022-07-17T15:00:01.000Z</createdDate>\n        <systemModstamp>2022-07-17T15:00:16.000Z</systemModstamp>\n        <numberRecordsProcessed>0</numberRecordsProcessed>\n        <numberRecordsFailed>0</numberRecordsFailed>\n        <totalProcessingTime>0</totalProcessingTime>\n        <apiActiveProcessingTime>0</apiActiveProcessingTime>\n        <apexProcessingTime>0</apexProcessingTime>\n    </batchInfo>\n    <batchInfo>\n        <id>751J0000006JoH6IAK</id>\n        <jobId>750J0000006VqfSIAS</jobId>\n        <state>Failed</state>\n        <stateMessage>InvalidBatch : Failed to process query: MALFORMED_QUERY: unexpected token: 'where'</stateMessage>\n        <createdDate>2022-07-17T15:00:01.000Z</createdDate>\n        <systemModstamp>2022-07-17T15:00:19.000Z</systemModstamp>\n        <numberRecordsProcessed>0</numberRecordsProcessed>\n        <numberRecordsFailed>0</numberRecordsFailed>\n        <totalProcessingTime>0</totalProcessingTime>\n        <apiActiveProcessingTime>0</apiActiveProcessingTime>\n        <apexProcessingTime>0</apexProcessingTime>\n    </batchInfo>\n    <batchInfo>\n        <id>751J0000006JoIWIA0</id>\n        <jobId>750J0000006VqfSIAS</jobId>\n        <state>NotProcessed</state>\n        <createdDate>2022-07-17T14:59:59.000Z</createdDate>\n        <systemModstamp>2022-07-17T15:00:02.000Z</systemModstamp>\n        <numberRecordsProcessed>0</numberRecordsProcessed>\n        <numberRecordsFailed>0</numberRecordsFailed>\n        <totalProcessingTime>0</totalProcessingTime>\n        <apiActiveProcessingTime>0</apiActiveProcessingTime>\n        <apexProcessingTime>0</apexProcessingTime>\n    </batchInfo>\n</batchInfoList>   \n";
+export declare const batchesDetails = "\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<batchInfoList\n   xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">\n    <batchInfo>\n        <id>751J0000006JoH5IAK</id>\n        <jobId>750J0000006VqfSIAS</jobId>\n        <state>Completed</state>\n        <createdDate>2022-07-17T15:00:01.000Z</createdDate>\n        <systemModstamp>2022-07-17T15:00:16.000Z</systemModstamp>\n        <numberRecordsProcessed>100475</numberRecordsProcessed>\n        <numberRecordsFailed>0</numberRecordsFailed>\n        <totalProcessingTime>0</totalProcessingTime>\n        <apiActiveProcessingTime>0</apiActiveProcessingTime>\n        <apexProcessingTime>0</apexProcessingTime>\n    </batchInfo>\n    <batchInfo>\n        <id>751J0000006JoH6IAK</id>\n        <jobId>750J0000006VqfSIAS</jobId>\n        <state>Completed</state>\n        <createdDate>2022-07-17T15:00:01.000Z</createdDate>\n        <systemModstamp>2022-07-17T15:00:19.000Z</systemModstamp>\n        <numberRecordsProcessed>104774</numberRecordsProcessed>\n        <numberRecordsFailed>0</numberRecordsFailed>\n        <totalProcessingTime>0</totalProcessingTime>\n        <apiActiveProcessingTime>0</apiActiveProcessingTime>\n        <apexProcessingTime>0</apexProcessingTime>\n    </batchInfo>\n    <batchInfo>\n        <id>751J0000006JoIWIA0</id>\n        <jobId>750J0000006VqfSIAS</jobId>\n        <state>NotProcessed</state>\n        <createdDate>2022-07-17T14:59:59.000Z</createdDate>\n        <systemModstamp>2022-07-17T15:00:02.000Z</systemModstamp>\n        <numberRecordsProcessed>0</numberRecordsProcessed>\n        <numberRecordsFailed>0</numberRecordsFailed>\n        <totalProcessingTime>0</totalProcessingTime>\n        <apiActiveProcessingTime>0</apiActiveProcessingTime>\n        <apexProcessingTime>0</apexProcessingTime>\n    </batchInfo>\n</batchInfoList>   \n";
+export declare const batch751J0000006JoH6IAKResult = "\n<result-list xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">\n    <result>752J0000002BrvU</result>\n    <result>752J0000002BrvE</result>\n</result-list>\n";
+export declare const result752J0000002BrvU = "\nId,Name\n1,DK\n2,DZ";
+export declare const result752J0000002BrvE = "\nId,Name\n3,VD";
+export declare const batch751J0000006JoH5IAKResult = "\n<result-list xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">\n    <result>752J0000002BrvQ</result>\n</result-list>\n";
+export declare const result752J0000002BrvQ = "\nId,Name\n4,IG";

package/dist/typings/classes/retrieve-data/bulk1-retrieve-data.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="node" />
+import BaseRetrieveData from './base-retrieve-data';
+import { RetrieveRequestBulk1 } from '../../interfaces/retrieve.interfaces';
+import * as stream from 'stream';
+export default class Bulk1RetrieveData extends BaseRetrieveData<stream.Readable | null> {
+    private readonly objectName;
+    private readonly indexField?;
+    private readonly indexFieldDirection?;
+    private readonly lastRetrievedIndex?;
+    private readonly api;
+    private readonly pollInterval;
+    private jobId;
+    private batchId;
+    private batchResultIds;
+    private get requestConfig();
+    private get query();
+    constructor({ instance, api, pollInterval, queryBuilder, objectName, indexDetails }: RetrieveRequestBulk1);
+    execute(): Promise<stream.Readable | null>;
+    closeJob(): Promise<void>;
+    private getResultIds;
+    private createBatch;
+    private waitCompletionBaseBatch;
+    private createJob;
+}

package/dist/typings/classes/retrieve-data/bulk1-retrieve-data.fixtures.d.ts

@@ -0,0 +1,37 @@
+export declare const JOB_ID = "750J0000006W7TJIA0";
+export declare const BASE_BATCH_ID = "751J0000006KCG5IAO";
+export declare const RESULT_ID_1 = "752J0000002BvIC";
+export declare const RESULT_ID_2 = "752J0000002BmIC";
+export declare const jobDetails: {
+    apexProcessingTime: number;
+    apiActiveProcessingTime: number;
+    apiVersion: number;
+    assignmentRuleId: any;
+    concurrencyMode: string;
+    contentType: string;
+    createdById: string;
+    createdDate: string;
+    externalIdFieldName: any;
+    fastPathEnabled: boolean;
+    id: string;
+    numberBatchesCompleted: number;
+    numberBatchesFailed: number;
+    numberBatchesInProgress: number;
+    numberBatchesQueued: number;
+    numberBatchesTotal: number;
+    numberRecordsFailed: number;
+    numberRecordsProcessed: number;
+    numberRetries: number;
+    object: string;
+    operation: string;
+    state: string;
+    systemModstamp: string;
+    totalProcessingTime: number;
+};
+export declare const baseBatchDetailsQueued: string;
+export declare const baseBatchDetailsInProgress: string;
+export declare const baseBatchDetailsError: string;
+export declare const baseBatchDetailsCompleted: string;
+export declare const batchResult: string;
+export declare const result1 = "\nId,Name\n3,VS";
+export declare const result2 = "Id,Name\n1,Accme\n2,TEST ACCOUNT";

package/dist/typings/classes/retrieve-data/bulk2-retrieve-data.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="node" />
+import { RetrieveRequestBulk2 } from '../../interfaces/retrieve.interfaces';
+import BaseRetrieveData from './base-retrieve-data';
+import * as stream from 'stream';
+export default class Bulk2RetrieveData extends BaseRetrieveData<stream.Readable | null> {
+    private readonly pollInterval;
+    private readonly maxRecords;
+    private readonly api;
+    private readonly indexField?;
+    private readonly indexFieldDirection?;
+    private lastRetrievedIndex?;
+    private jobId;
+    private queryLocator;
+    private get query();
+    constructor({ instance, queryBuilder, pollInterval, maxRecords, api, indexDetails }: RetrieveRequestBulk2);
+    private get requestResultConfig();
+    execute(): Promise<stream.Readable | null>;
+    private waitToCompleteJob;
+}

package/dist/typings/classes/retrieve-data/bulk2-retrieve-data.fixtures.d.ts

@@ -0,0 +1,8 @@
+import { Bulk2JobQuery, Bulk2JobQueryStatus } from '../../interfaces/bulk2.interfaces';
+export declare const jobId = "750R0000000zlh9IAA";
+export declare const sforceLocator = "MTAwMDA";
+export declare const createBulkJobQueryResponse: Bulk2JobQuery;
+export declare const statusBulkJonQueryInProgressResponse: Bulk2JobQueryStatus;
+export declare const statusBulkJonQueryCompletedResponse: Bulk2JobQueryStatus;
+export declare const testRecordsChunkOne = "Id,Name\n1,Test 1\n2,Test 2\n3,Test 3\n4,Test 4\n5,Test 5\n6,Test 6\n7,Test 7\n8,Test 8\n9,Test 9\n10,Test 10";
+export declare const testRecordsChunkTwo = "Id,Name\n11,Test 11\n12,Test 12";

package/dist/typings/classes/retrieve-data/custom-rest-retrieve-data.d.ts

@@ -0,0 +1,12 @@
+import { RetrieveRequestCustomRest, RetrieveResult } from '../../interfaces/retrieve.interfaces';
+import BaseSfRetrieveData from './base-retrieve-data';
+export default class CustomRestRetrieveData extends BaseSfRetrieveData<RetrieveResult> {
+    private readonly endpoint;
+    private readonly maxRecords;
+    private readonly indexField;
+    private readonly indexFieldDirection;
+    private lastRetrievedIndex?;
+    private get query();
+    constructor({ instance, queryBuilder, endpoint, maxRecords, indexDetails }: RetrieveRequestCustomRest);
+    execute(): Promise<RetrieveResult>;
+}

package/dist/typings/classes/retrieve-data/custom-rest-retrieve-data.fixtures.d.ts

@@ -0,0 +1,8 @@
+export declare const testRecordsForTestOne: {
+    Id: string;
+    Name: string;
+}[];
+export declare const testRecordsForTestTwo: {
+    Id: string;
+    Name: string;
+}[];

package/dist/typings/classes/retrieve-data/standard-rest-pk-limit-retrieve-data.d.ts

@@ -0,0 +1,14 @@
+import { RetrieveRequestStandardRestPkLimit, RetrieveResult } from '../../interfaces/retrieve.interfaces';
+import BaseSfRetrieveData from './base-retrieve-data';
+export default class StandardRestPkLimitRetrieveData extends BaseSfRetrieveData<RetrieveResult> {
+    private readonly maxRecords;
+    private readonly indexField;
+    private readonly indexFieldDirection;
+    private readonly api;
+    private readonly chunkQuerySize;
+    private lastRetrievedIndex?;
+    private queryLocator;
+    private get requestConfig();
+    constructor({ instance, queryBuilder, maxRecords, api, chunkQuerySize, indexDetails, }: RetrieveRequestStandardRestPkLimit);
+    execute(): Promise<RetrieveResult>;
+}

package/dist/typings/classes/retrieve-data/standard-rest-pk-limit-retrieve-data.fixtures.d.ts

@@ -0,0 +1,6 @@
+export declare const testRecords: {
+    Id: number;
+    Name: string;
+}[];
+export declare const maxRecords = 200;
+export declare const nextRecordUrl: string;

package/dist/typings/classes/retrieve-data/standard-rest-pk-retrieve-data.d.ts

@@ -0,0 +1,17 @@
+import { RetrieveRequestStandardRestPk, RetrieveResult } from '../../interfaces/retrieve.interfaces';
+import BaseSfRetrieveData from './base-retrieve-data';
+export default class StandardRestPkRetrieveData extends BaseSfRetrieveData<RetrieveResult> {
+    private static readonly DEFAULT_CHUNK_QUERY_SIZE;
+    private readonly maxRecords;
+    private readonly api;
+    private lastRetrievedIndex?;
+    private currentChunk;
+    private chunks;
+    private queryLocator;
+    private chunkQuerySize;
+    private get requestConfig();
+    constructor({ api, queryBuilder, instance, maxRecords, chunkQuerySize, indexDetails, }: RetrieveRequestStandardRestPk);
+    private fetchId;
+    private init;
+    execute(): Promise<RetrieveResult>;
+}

package/dist/typings/classes/retrieve-data/standard-rest-retrieve-data.d.ts

@@ -0,0 +1,14 @@
+import { RetrieveRequestStandardRest, RetrieveResult } from '../../interfaces/retrieve.interfaces';
+import BaseSfRetrieveData from './base-retrieve-data';
+export default class StandardRestRetrieveData extends BaseSfRetrieveData<RetrieveResult> {
+    private readonly maxRecords;
+    private readonly api;
+    private readonly indexField;
+    private readonly indexFieldDirection;
+    private lastRetrievedIndex?;
+    private queryLocator;
+    private get query();
+    private get requestConfig();
+    constructor({ api, queryBuilder, instance, maxRecords, indexDetails }: RetrieveRequestStandardRest);
+    execute(): Promise<RetrieveResult>;
+}

package/dist/typings/classes/retrieve-data/standard-rest-retrieve-data.fixtures.d.ts

@@ -0,0 +1,6 @@
+export declare const testRecords: {
+    Id: number;
+    Name: string;
+}[];
+export declare const maxRecords = 200;
+export declare const nextRecordUrl: string;

package/dist/typings/classes/retrieve-metadata/base.retrieve.d.ts

@@ -0,0 +1,16 @@
+import { AxiosInstance } from 'axios';
+import { DescribeMetadataResult, ListMetadataItemDetails, SoapRetrieveMetadataResult } from '../../interfaces';
+import { Logger } from '..';
+export default abstract class BaseRetrieve {
+    protected readonly apiVersion: string;
+    protected readonly axiosInstance: AxiosInstance;
+    protected readonly logger: Logger;
+    protected readonly isFullParents: boolean;
+    protected describeMetadataResult: DescribeMetadataResult;
+    protected listMetadataItems: ListMetadataItemDetails[];
+    constructor(apiVersion: string, axiosInstance: AxiosInstance, logger: Logger, isFullParents?: boolean);
+    private describeMetadata;
+    private retrieve;
+    protected abstract listMetadata(): Promise<void>;
+    execute(): Promise<SoapRetrieveMetadataResult>;
+}

package/dist/typings/classes/retrieve-metadata/full.retrieve.d.ts

@@ -0,0 +1,4 @@
+import BaseRetrieve from './base.retrieve';
+export default class FullRetrieve extends BaseRetrieve {
+    protected listMetadata(): Promise<void>;
+}

package/dist/typings/classes/retrieve-metadata/handlers/base-metadata.handler.d.ts

@@ -0,0 +1,11 @@
+import { DescribeMetadataItem, ContentFile, ListMetadataItem, MetadataComponent } from '../../../interfaces';
+export default abstract class BaseMetadataHandler {
+    protected readonly describe: Record<string, DescribeMetadataItem>;
+    protected readonly item: ListMetadataItem;
+    protected readonly files: Record<string, ContentFile>;
+    protected get filePath(): string;
+    protected get metaFilePath(): string;
+    constructor(describe: Record<string, DescribeMetadataItem>, item: ListMetadataItem, files: Record<string, ContentFile>);
+    abstract execute(): Promise<MetadataComponent>;
+    protected parseXml(xml: string): Promise<Record<string, any>>;
+}

package/dist/typings/classes/retrieve-metadata/handlers/bundle-metadata.handler.d.ts

@@ -0,0 +1,5 @@
+import BaseMetadataHandler from './base-metadata.handler';
+import { MetadataComponent } from '../../../interfaces';
+export default class BundleMetadataHandler extends BaseMetadataHandler {
+    execute(): Promise<MetadataComponent>;
+}

package/dist/typings/classes/retrieve-metadata/handlers/child-metadata.handler.d.ts

@@ -0,0 +1,7 @@
+import BaseMetadataHandler from './base-metadata.handler';
+import { ContentFile, DescribeMetadataItem, ListMetadataItem, MetadataComponent } from '../../../interfaces';
+export default class ChildMetadataHandler extends BaseMetadataHandler {
+    private readonly _isFullParents;
+    constructor(describe: Record<string, DescribeMetadataItem>, item: ListMetadataItem, files: Record<string, ContentFile>, _isFullParents: boolean);
+    execute(): Promise<MetadataComponent>;
+}

package/dist/typings/classes/retrieve-metadata/handlers/default-metadata.handler.d.ts

@@ -0,0 +1,5 @@
+import BaseMetadataHandler from './base-metadata.handler';
+import { MetadataComponent } from '../../../interfaces';
+export default class DefaultMetadataHandler extends BaseMetadataHandler {
+    execute(): Promise<MetadataComponent>;
+}

package/dist/typings/classes/retrieve-metadata/handlers/metadata-handler-factory.d.ts

@@ -0,0 +1,6 @@
+import BaseMetadataHandler from './base-metadata.handler';
+import { DescribeMetadataItem, ContentFile, ListMetadataItem } from '../../../interfaces';
+import { MetadataType } from '../../../enums/type.metadata.enum';
+export default class MetadataHandlerFactory {
+    static create(type: MetadataType, describe: Record<string, DescribeMetadataItem>, item: ListMetadataItem, zip: Record<string, ContentFile>, isFullParents: boolean): BaseMetadataHandler;
+}

package/dist/typings/classes/retrieve-metadata/handlers/parent-metadata.handler.d.ts

@@ -0,0 +1,7 @@
+import BaseMetadataHandler from './base-metadata.handler';
+import { ContentFile, DescribeMetadataItem, ListMetadataItem, MetadataComponent } from '../../../interfaces';
+export default class ParentMetadataHandler extends BaseMetadataHandler {
+    private readonly _isFullParents;
+    constructor(describe: Record<string, DescribeMetadataItem>, item: ListMetadataItem, files: Record<string, ContentFile>, _isFullParents: boolean);
+    execute(): Promise<MetadataComponent>;
+}

package/dist/typings/classes/retrieve-metadata/handlers/with-meta-xml-metadata.handler.d.ts

@@ -0,0 +1,5 @@
+import BaseMetadataHandler from './base-metadata.handler';
+import { MetadataComponent } from '../../../interfaces';
+export default class WithMetaXmlMetadataHandler extends BaseMetadataHandler {
+    execute(): Promise<MetadataComponent>;
+}

package/dist/typings/classes/retrieve-metadata/list-metadata/base.folder.list-metadata.d.ts

@@ -0,0 +1,20 @@
+import { DescribeMetadataItem, ListMetadataItemDetails } from '../../../interfaces';
+import { Logger } from '../..';
+import BaseListMetadata from './base.list-metadata';
+import { AxiosInstance } from 'axios';
+export default abstract class BaseFolderListMetadata extends BaseListMetadata {
+    protected folderNameMap: Record<string, string>;
+    protected readonly describeItem: DescribeMetadataItem;
+    protected readonly items: ListMetadataItemDetails[];
+    constructor({ describeItem, ...baseOptions }: {
+        apiVersion: string;
+        axiosInstance: AxiosInstance;
+        logger: Logger;
+        describeItem: DescribeMetadataItem;
+    });
+    protected request<T>(query: string): Promise<T[]>;
+    private getParentFoldersRecords;
+    private convertToIdPathMap;
+    private getPath;
+    protected listMetadataFolder(): Promise<void>;
+}

package/dist/typings/classes/retrieve-metadata/list-metadata/base.list-metadata.d.ts

@@ -0,0 +1,16 @@
+import { ListMetadataItem, ListMetadataItemDetails, ListMetadataType } from '../../../interfaces';
+import { Logger } from '../..';
+import { AxiosInstance } from 'axios';
+export default abstract class BaseListMetadata {
+    protected readonly apiVersion: string;
+    protected readonly axiosInstance: AxiosInstance;
+    protected readonly logger: Logger;
+    constructor({ apiVersion, axiosInstance, logger, }: {
+        apiVersion: string;
+        axiosInstance: AxiosInstance;
+        logger: Logger;
+    });
+    abstract execute(): Promise<ListMetadataItemDetails[]>;
+    protected listMetadataChunk(types: ListMetadataType[]): Promise<ListMetadataItem[]>;
+    protected listMetadata(types: ListMetadataType[]): Promise<ListMetadataItem[]>;
+}

package/dist/typings/classes/retrieve-metadata/list-metadata/default.list-metadata.d.ts

@@ -0,0 +1,15 @@
+import { DescribeMetadataItem, ListMetadataItem, ListMetadataItemDetails, ListMetadataType } from '../../../interfaces';
+import BaseListMetadata from './base.list-metadata';
+import { AxiosInstance } from 'axios';
+import { Logger } from '../..';
+export default class DefaultListMetadata extends BaseListMetadata {
+    private readonly describeItem;
+    constructor({ describeItem, ...baseOptions }: {
+        apiVersion: string;
+        axiosInstance: AxiosInstance;
+        logger: Logger;
+        describeItem: DescribeMetadataItem[];
+    });
+    protected listMetadata(types: ListMetadataType[]): Promise<ListMetadataItem[]>;
+    execute(): Promise<ListMetadataItemDetails[]>;
+}

package/dist/typings/classes/retrieve-metadata/list-metadata/folder-list.metadata.d.ts

@@ -0,0 +1,16 @@
+import { DescribeMetadataItem, ListMetadataItemDetails } from '../../../interfaces';
+import BaseListMetadata from './base.list-metadata';
+import { AxiosInstance } from 'axios';
+import { Logger } from '../..';
+export default class FolderListMetadata extends BaseListMetadata {
+    private readonly items;
+    private readonly describeItem;
+    constructor({ describeItem, ...baseOptions }: {
+        apiVersion: string;
+        axiosInstance: AxiosInstance;
+        logger: Logger;
+        describeItem: DescribeMetadataItem;
+    });
+    private listMetadataFolder;
+    execute(): Promise<ListMetadataItemDetails[]>;
+}

package/dist/typings/classes/retrieve-metadata/list-metadata/manager.list-metadata.d.ts

@@ -0,0 +1,13 @@
+import { DescribeMetadataResult, ListMetadataItemDetails } from '../../../interfaces';
+import { AxiosInstance } from 'axios';
+import { Logger } from '../..';
+export default class ManagerListMetadata {
+    private readonly _apiVersion;
+    private readonly _axiosInstance;
+    private readonly _describeMetadata;
+    private readonly _logger;
+    private listMetadataItems;
+    constructor(_apiVersion: string, _axiosInstance: AxiosInstance, _describeMetadata: DescribeMetadataResult, _logger: Logger);
+    private runListMetadata;
+    execute(): Promise<ListMetadataItemDetails[]>;
+}

package/dist/typings/classes/retrieve-metadata/list-metadata/parent.list-metadata.d.ts

@@ -0,0 +1,18 @@
+import BaseListMetadata from './base.list-metadata';
+import { DescribeMetadataItem, ListMetadataItemDetails } from '../../../interfaces';
+import { AxiosInstance } from 'axios';
+import { Logger } from '../..';
+export default class ParentListMetadata extends BaseListMetadata {
+    private _items;
+    private readonly _describeItem;
+    constructor({ describeItem, ...baseOptions }: {
+        apiVersion: string;
+        axiosInstance: AxiosInstance;
+        logger: Logger;
+        describeItem: DescribeMetadataItem;
+    });
+    execute(): Promise<ListMetadataItemDetails[]>;
+    private parentListMetadata;
+    private childListMetadata;
+    private handleChildListMetadata;
+}

package/dist/typings/classes/retrieve-metadata/list-metadata/record-types.list-metadata.d.ts

@@ -0,0 +1,15 @@
+import { DescribeMetadataItem, ListMetadataItemDetails } from '../../../interfaces';
+import BaseListMetadata from './base.list-metadata';
+import { Logger } from '../..';
+import { AxiosInstance } from 'axios';
+export default class RecordTypesListMetadata extends BaseListMetadata {
+    protected readonly describeItem: DescribeMetadataItem;
+    constructor({ describeItem, ...baseOptions }: {
+        apiVersion: string;
+        axiosInstance: AxiosInstance;
+        logger: Logger;
+        describeItem: DescribeMetadataItem;
+    });
+    private getPersonRecordTypes;
+    execute(): Promise<ListMetadataItemDetails[]>;
+}