@coveo/push-api-client 1.7.0 → 2.0.0

package/dist/definitions/environment.d.ts

@@ -9,8 +9,8 @@ export declare enum PlatformEnvironment {
 export declare const DEFAULT_ENVIRONMENT: PlatformEnvironment.Prod;
 export declare const DEFAULT_REGION: Region.US;
 export declare type PlatformUrlOptions = {
-    environment: PlatformEnvironment;
-    region: Region;
+    environment?: PlatformEnvironment;
+    region?: Region;
 };
-export declare function platformUrl(options?: Partial<PlatformUrlOptions>): string;
+export declare function platformUrl(options?: PlatformUrlOptions): string;
 export declare function castEnvironmentToPlatformClient(e: PlatformEnvironment): Environment;

package/dist/definitions/help/fileConsumer.d.ts

@@ -0,0 +1,26 @@
+import { BatchUpdateDocuments, UploadBatchCallbackData, ConcurrentProcessing } from '../interfaces';
+import { AxiosResponse } from 'axios';
+export declare type SuccessfulUploadCallback = (data: UploadBatchCallbackData) => void;
+export declare type FailedUploadCallback = (err: unknown, value: UploadBatchCallbackData) => void;
+/**
+ * Util class to help injesting documents through a list of files and uploading generated document batches.
+ */
+export declare class FileConsumer {
+    private upload;
+    private processingConfig;
+    private static maxContentLength;
+    private cbSuccess;
+    private cbFail;
+    /**
+     * Creates an instance of FileConsumer.
+     * @param {(batch: BatchUpdateDocuments) => Promise<AxiosResponse>} upload the upload operation to apply to every document batch
+     * @param {Required<ConcurrentProcessing>} processingConfig
+     */
+    constructor(upload: (batch: BatchUpdateDocuments) => Promise<AxiosResponse>, processingConfig: Required<ConcurrentProcessing>);
+    consume(files: string[]): Promise<void>;
+    onSuccess(callback: SuccessfulUploadCallback): void;
+    onError(callback: FailedUploadCallback): void;
+    private splitByChunkAndUpload;
+    private uploadBatch;
+    private get accumulator();
+}

package/dist/definitions/index.d.ts

@@ -1,6 +1,10 @@
 export * from './document';
-export { Source, SourceVisibility, BatchUpdateDocuments, UploadBatchCallback, UploadBatchCallbackData, BatchUpdateDocumentsFromFiles, } from './source';
+export { Source } from './source/source';
+export { PushSource } from './source/push';
+export { SuccessfulUploadCallback, FailedUploadCallback, } from './help/fileConsumer';
+export { UploadBatchCallbackData, BatchUpdateDocuments, BatchUpdateDocumentsFromFiles, } from './interfaces';
 export { FieldAnalyser } from './fieldAnalyser/fieldAnalyser';
 export { DocumentBuilder } from './documentBuilder';
 export * from './securityIdentityBuilder';
-export { PlatformEnvironment, Region } from './environment';
+export { PlatformEnvironment, Region, PlatformUrlOptions } from './environment';
+export { SourceVisibility } from '@coveord/platform-client';

package/dist/definitions/interfaces.d.ts

@@ -0,0 +1,36 @@
+import type { AxiosResponse } from 'axios';
+import type { DocumentBuilder } from './documentBuilder';
+export interface BatchUpdateDocuments {
+    addOrUpdate: DocumentBuilder[];
+    delete: {
+        documentId: string;
+        deleteChildren: boolean;
+    }[];
+}
+/**
+ *
+ * @param {string[]} files Files from which the documentBuilders were generated
+ * @param {DocumentBuilder[]} batch List of the uploaded DocumentBuilders
+ * @param {AxiosResponse} res Axios response
+ */
+export interface UploadBatchCallbackData {
+    files: string[];
+    batch: DocumentBuilder[];
+    res?: AxiosResponse;
+}
+export interface BatchUpdateDocumentsOptions {
+    /**
+     * Whether to create fields required in the index based on the document batch metadata.
+     */
+    createFields?: boolean;
+}
+export interface ConcurrentProcessing {
+    /**
+     * The maximum number of requests to send concurrently to the Coveo platform.
+     * Increasing this value will increase the speed at which documents are pushed but will also consume more memory.
+     *
+     * The default value is set to 10.
+     */
+    maxConcurrent?: number;
+}
+export declare type BatchUpdateDocumentsFromFiles = BatchUpdateDocumentsOptions & ConcurrentProcessing;

package/dist/definitions/source/batchUpdateDocumentsFromFile.d.ts

@@ -0,0 +1,10 @@
+import { BatchUpdateDocumentsFromFiles, FailedUploadCallback, SuccessfulUploadCallback } from '../index';
+import type { PushSource } from './push';
+export declare class BatchUpdateDocumentsFromFilesReturn {
+    private internalPromise;
+    private batchConsumer;
+    constructor(pushSource: PushSource, sourceId: string, filesOrDirectories: string[], options?: BatchUpdateDocumentsFromFiles);
+    onBatchUpload(cb: SuccessfulUploadCallback): this;
+    onBatchError(cb: FailedUploadCallback): this;
+    batch(): Promise<void>;
+}

package/dist/definitions/{source.d.ts → source/push.d.ts}

@@ -1,61 +1,29 @@
-import { SecurityIdentityAliasModel, SecurityIdentityBatchConfig, SecurityIdentityDelete, SecurityIdentityDeleteOptions, SecurityIdentityModel, SourceVisibility } from '@coveord/platform-client';
+import { PlatformClient, SecurityIdentityAliasModel, SecurityIdentityBatchConfig, SecurityIdentityDelete, SecurityIdentityDeleteOptions, SecurityIdentityModel, SourceVisibility } from '@coveord/platform-client';
 export { SourceVisibility } from '@coveord/platform-client';
-import { AxiosResponse } from 'axios';
-import { DocumentBuilder } from './documentBuilder';
-import { PlatformUrlOptions } from './environment';
+import { DocumentBuilder } from '../documentBuilder';
+import { PlatformUrlOptions } from '../environment';
+import { FieldAnalyser } from '../fieldAnalyser/fieldAnalyser';
+import { SecurityIdentity } from './securityIdenty';
+import { BatchUpdateDocuments, BatchUpdateDocumentsOptions, BatchUpdateDocumentsFromFiles } from '../interfaces';
+import { BatchUpdateDocumentsFromFilesReturn } from './batchUpdateDocumentsFromFile';
 export declare type SourceStatus = 'REBUILD' | 'REFRESH' | 'INCREMENTAL' | 'IDLE';
-export interface BatchUpdateDocuments {
-    addOrUpdate: DocumentBuilder[];
-    delete: {
-        documentId: string;
-        deleteChildren: boolean;
-    }[];
-}
-/**
- *
- * @param {string[]} files Files from which the documentBuilders were generated
- * @param {DocumentBuilder[]} batch List of the uploaded DocumentBuilders
- * @param {AxiosResponse} res Axios response
- */
-export interface UploadBatchCallbackData {
-    files: string[];
-    batch: DocumentBuilder[];
-    res?: AxiosResponse;
-}
-export declare type UploadBatchCallback = (err: unknown | null, data: UploadBatchCallbackData) => void;
-export interface BatchUpdateDocumentsOptions {
-    /**
-     * Whether to create fields required in the index based on the document batch metadata.
-     */
-    createFields?: boolean;
-}
-export interface BatchUpdateDocumentsFromFiles extends BatchUpdateDocumentsOptions {
-    /**
-     * The maximum number of requests to send concurrently to the Coveo platform.
-     * Increasing this value will increase the speed at which documents are pushed but will also consume more memory.
-     *
-     * The default value is set to 10.
-     */
-    maxConcurrent?: number;
-}
 /**
  * Manage a push source.
  *
  * Allows you to create a new push source, manage security identities and documents in a Coveo organization.
  */
-export declare class Source {
+export declare class PushSource {
     private apikey;
     private organizationid;
-    private platformClient;
+    platformClient: PlatformClient;
     private options;
     private static defaultOptions;
-    private static maxContentLength;
     /**
      *
      * @param apikey An apiKey capable of pushing documents and managing sources in a Coveo organization. See [Manage API Keys](https://docs.coveo.com/en/1718).
      * @param organizationid The Coveo Organization identifier.
      */
-    constructor(apikey: string, organizationid: string, options?: Partial<PlatformUrlOptions>);
+    constructor(apikey: string, organizationid: string, options?: PlatformUrlOptions);
     /**
      * Create a new push source
      * @param name The name of the source to create.
@@ -66,37 +34,36 @@ export declare class Source {
         id: string;
     }>;
     /**
-     * Create or update a security identity. See [Adding a Single Security Identity](https://docs.coveo.com/en/167) and [Security Identity Models](https://docs.coveo.com/en/139).
-     * @param securityProviderId
-     * @param securityIdentity
-     * @returns
+     * @deprecated use `identity.createSecurityIdentity`
+     *
+     * See {@link Source.identity}
      */
     createSecurityIdentity(securityProviderId: string, securityIdentity: SecurityIdentityModel): Promise<void>;
     /**
-     * Create or update a security identity alias. See [Adding a Single Alias](https://docs.coveo.com/en/142) and [User Alias Definition Examples](https://docs.coveo.com/en/46).
-     * @param securityProviderId
-     * @param securityIdentityAlias
-     * @returns
+     * @deprecated use `identity.createOrUpdateSecurityIdentityAlias`
+     *
+     * See {@link Source.identity}
      */
     createOrUpdateSecurityIdentityAlias(securityProviderId: string, securityIdentityAlias: SecurityIdentityAliasModel): Promise<void>;
     /**
-     * Delete a security identity. See [Disabling a Single Security Identity](https://docs.coveo.com/en/84).
-     * @param securityProviderId
-     * @param securityIdentityToDelete
-     * @returns
+     * @deprecated use `identity.deleteSecurityIdentity`
+     *
+     * See {@link Source.identity}
      */
     deleteSecurityIdentity(securityProviderId: string, securityIdentityToDelete: SecurityIdentityDelete): Promise<void>;
     /**
-     * Delete old security identities. See [Disabling Old Security Identities](https://docs.coveo.com/en/33).
-     * @param securityProviderId
-     * @param batchDelete
-     * @returns
+     * @deprecated use `identity.deleteOldSecurityIdentities`
+     *
+     * See {@link Source.identity}
      */
     deleteOldSecurityIdentities(securityProviderId: string, batchDelete: SecurityIdentityDeleteOptions): Promise<void>;
     /**
-     * Manage batches of security identities. See [Manage Batches of Security Identities](https://docs.coveo.com/en/55).
+     * @deprecated use `identity.manageSecurityIdentities`
+     *
+     * See {@link Source.identity}
      */
     manageSecurityIdentities(securityProviderId: string, batchConfig: SecurityIdentityBatchConfig): Promise<void>;
+    get identity(): SecurityIdentity;
     /**
      * Adds or updates an individual item in a push source. See [Adding a Single Item in a Push Source](https://docs.coveo.com/en/133).
      * @param sourceID
@@ -104,14 +71,14 @@ export declare class Source {
      * @param {BatchUpdateDocumentsOptions} [{createFields = true}={}]
      * @returns
      */
-    addOrUpdateDocument(sourceID: string, docBuilder: DocumentBuilder, { createFields: createFields }?: BatchUpdateDocumentsOptions): Promise<AxiosResponse<any, any>>;
+    addOrUpdateDocument(sourceID: string, docBuilder: DocumentBuilder, { createFields: createFields }?: BatchUpdateDocumentsOptions): Promise<import("axios").AxiosResponse<any, any>>;
     /**
      * Manage batches of items in a push source. See [Manage Batches of Items in a Push Source](https://docs.coveo.com/en/90)
      * @param sourceID
      * @param batch
      * @returns
      */
-    batchUpdateDocuments(sourceID: string, batch: BatchUpdateDocuments, { createFields: createFields }?: BatchUpdateDocumentsOptions): Promise<AxiosResponse<any, any>>;
+    batchUpdateDocuments(sourceID: string, batch: BatchUpdateDocuments, { createFields: createFields }?: BatchUpdateDocumentsOptions): Promise<import("axios").AxiosResponse<any, any>>;
     /**
      *
      * Manage batches of items in a push source from a list of JSON files. See [Manage Batches of Items in a Push Source](https://docs.coveo.com/en/90)
@@ -120,7 +87,7 @@ export declare class Source {
      * @param {UploadBatchCallback} callback Callback executed when a batch of documents is either successfully uploaded or when an error occurs during the upload
      * @param {BatchUpdateDocumentsFromFiles} options
      */
-    batchUpdateDocumentsFromFiles(sourceID: string, filesOrDirectories: string[], callback: UploadBatchCallback, options?: BatchUpdateDocumentsFromFiles): Promise<void>;
+    batchUpdateDocumentsFromFiles(sourceID: string, filesOrDirectories: string[], options?: BatchUpdateDocumentsFromFiles): BatchUpdateDocumentsFromFilesReturn;
     /**
      * Deletes a specific item from a Push source. Optionally, the child items of that item can also be deleted. See [Deleting an Item in a Push Source](https://docs.coveo.com/en/171).
      * @param sourceID
@@ -128,32 +95,30 @@ export declare class Source {
      * @param deleteChildren
      * @returns
      */
-    deleteDocument(sourceID: string, documentId: string, deleteChildren?: boolean): Promise<AxiosResponse<any, any>>;
+    deleteDocument(sourceID: string, documentId: string, deleteChildren?: boolean): Promise<import("axios").AxiosResponse<any, any>>;
     /**
      * Deletes all items whose last update was made by a Push API operation whose orderingId is strictly lower than a specified value. See [Deleting Old Items in a Push Source](https://docs.coveo.com/en/131).
      * @param sourceID
      * @param olderThan
      * @returns
      */
-    deleteDocumentsOlderThan(sourceID: string, olderThan: Date | string | number): Promise<AxiosResponse<any, any>>;
+    deleteDocumentsOlderThan(sourceID: string, olderThan: Date | string | number): Promise<import("axios").AxiosResponse<any, any>>;
     /**
      * Set the status of a push source. See [Updating the Status of a Push Source](https://docs.coveo.com/en/35/)
      * @param sourceID
      * @param status
      * @returns
      */
-    setSourceStatus(sourceID: string, status: SourceStatus): Promise<AxiosResponse<any, any>>;
+    setSourceStatus(sourceID: string, status: SourceStatus): Promise<import("axios").AxiosResponse<any, any>>;
+    uploadBatch(sourceID: string, batch: BatchUpdateDocuments): Promise<import("axios").AxiosResponse<any, any>>;
     private get baseAPIURL();
     private getBaseAPIURLForDocuments;
     private get documentsAxiosConfig();
-    private createFields;
+    createFields(analyser: FieldAnalyser): Promise<void>;
     private getFileContainerAxiosConfig;
     private get documentsRequestHeaders();
     private get authorizationHeader();
     private createFileContainer;
     private uploadContentToFileContainer;
     private pushFileContainerContent;
-    private splitByChunkAndUpload;
-    private uploadBatch;
-    private get accumulator();
 }

package/dist/definitions/source/push.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/definitions/source/securityIdenty.d.ts

@@ -0,0 +1,42 @@
+import { PlatformClient, SecurityIdentityAliasModel, SecurityIdentityBatchConfig, SecurityIdentityDelete, SecurityIdentityDeleteOptions, SecurityIdentityModel } from '@coveord/platform-client';
+export declare class SecurityIdentity {
+    private platformClient;
+    /**
+     *
+     * @param apikey An apiKey capable of pushing documents and managing sources in a Coveo organization. See [Manage API Keys](https://docs.coveo.com/en/1718).
+     * @param organizationid The Coveo Organization identifier.
+     */
+    constructor(platformClient: PlatformClient);
+    /**
+     * Create or update a security identity. See [Adding a Single Security Identity](https://docs.coveo.com/en/167) and [Security Identity Models](https://docs.coveo.com/en/139).
+     * @param securityProviderId
+     * @param securityIdentity
+     * @returns
+     */
+    createSecurityIdentity(securityProviderId: string, securityIdentity: SecurityIdentityModel): Promise<void>;
+    /**
+     * Create or update a security identity alias. See [Adding a Single Alias](https://docs.coveo.com/en/142) and [User Alias Definition Examples](https://docs.coveo.com/en/46).
+     * @param securityProviderId
+     * @param securityIdentityAlias
+     * @returns
+     */
+    createOrUpdateSecurityIdentityAlias(securityProviderId: string, securityIdentityAlias: SecurityIdentityAliasModel): Promise<void>;
+    /**
+     * Delete a security identity. See [Disabling a Single Security Identity](https://docs.coveo.com/en/84).
+     * @param securityProviderId
+     * @param securityIdentityToDelete
+     * @returns
+     */
+    deleteSecurityIdentity(securityProviderId: string, securityIdentityToDelete: SecurityIdentityDelete): Promise<void>;
+    /**
+     * Delete old security identities. See [Disabling Old Security Identities](https://docs.coveo.com/en/33).
+     * @param securityProviderId
+     * @param batchDelete
+     * @returns
+     */
+    deleteOldSecurityIdentities(securityProviderId: string, batchDelete: SecurityIdentityDeleteOptions): Promise<void>;
+    /**
+     * Manage batches of security identities. See [Manage Batches of Security Identities](https://docs.coveo.com/en/55).
+     */
+    manageSecurityIdentities(securityProviderId: string, batchConfig: SecurityIdentityBatchConfig): Promise<void>;
+}

package/dist/definitions/source/source.d.ts

@@ -0,0 +1,5 @@
+import { PushSource } from './push';
+/**
+ * @deprecated This class has been replaced by {@link PushSource}
+ */
+export declare const Source: typeof PushSource;