@coveo/push-api-client 2.0.0 → 2.1.2

package/README.md

@@ -9,10 +9,10 @@ Coveo Push API client
 ## Usage
 
 ```js
-import {Source, DocumentBuilder} from '@coveo/push-api-client';
+import {PushSource, DocumentBuilder} from '@coveo/push-api-client';
 
 async function main() {
-  const source = new Source('my_api_key', 'my_coveo_organization_id');
+  const source = new PushSource('my_api_key', 'my_coveo_organization_id');
 
   const myDocument = new DocumentBuilder(
     'https://my.document.uri',

package/dist/definitions/errors/privilegeError.d.ts

@@ -0,0 +1,6 @@
+import { PushApiClientBaseError } from './baseError';
+export declare class PrivilegeError extends PushApiClientBaseError {
+    message: string;
+    name: string;
+    constructor(message: string);
+}

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

@@ -0,0 +1,2 @@
+import type { AxiosRequestConfig } from 'axios';
+export declare const axiosRequestHeaders: (apikey: string) => AxiosRequestConfig;

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

@@ -0,0 +1,9 @@
+import { AxiosRequestConfig } from 'axios';
+import { BatchUpdateDocuments } from '../interfaces';
+export interface FileContainerResponse {
+    uploadUri: string;
+    fileId: string;
+    requiredHeaders: Record<string, string>;
+}
+export declare const uploadContentToFileContainer: (fileContainer: FileContainerResponse, batch: BatchUpdateDocuments) => Promise<import("axios").AxiosResponse<any, any>>;
+export declare const getFileContainerAxiosConfig: (fileContainer: FileContainerResponse) => AxiosRequestConfig;

package/dist/definitions/help/fileContainer.spec.d.ts

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

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

@@ -0,0 +1,27 @@
+/// <reference types="node" />
+import { PlatformUrlOptions } from '..';
+export interface URLBuilder {
+    baseAPIURLForUpdate: URL;
+    fileContainerUrl: URL;
+}
+declare abstract class BaseUrlBuilder {
+    private organizationId;
+    private options;
+    protected constructor(organizationId: string, options: Required<PlatformUrlOptions>);
+    protected get platformURL(): string;
+    get fileContainerUrl(): import("url").URL;
+    abstract get baseAPIURLForUpdate(): URL;
+}
+export declare class PushUrlBuilder extends BaseUrlBuilder implements URLBuilder {
+    private sourceId;
+    constructor(sourceId: string, organizationId: string, options: Required<PlatformUrlOptions>);
+    get baseURL(): import("url").URL;
+    get baseAPIURLForUpdate(): import("url").URL;
+}
+export declare class StreamUrlBuilder extends BaseUrlBuilder implements URLBuilder {
+    private sourceId;
+    constructor(sourceId: string, organizationId: string, options: Required<PlatformUrlOptions>);
+    get baseStreamURL(): import("url").URL;
+    get baseAPIURLForUpdate(): import("url").URL;
+}
+export {};

package/dist/definitions/index.d.ts

@@ -1,6 +1,7 @@
 export * from './document';
 export { Source } from './source/source';
 export { PushSource } from './source/push';
+export { CatalogSource } from './source/catalog';
 export { SuccessfulUploadCallback, FailedUploadCallback, } from './help/fileConsumer';
 export { UploadBatchCallbackData, BatchUpdateDocuments, BatchUpdateDocumentsFromFiles, } from './interfaces';
 export { FieldAnalyser } from './fieldAnalyser/fieldAnalyser';

package/dist/definitions/interfaces.d.ts

@@ -20,7 +20,10 @@ export interface UploadBatchCallbackData {
 }
 export interface BatchUpdateDocumentsOptions {
     /**
-     * Whether to create fields required in the index based on the document batch metadata.
+     * Whether to create the missing fields required in the index based on the document batch metadata.
+     *
+     * Make sure your API key is granted the privilege to EDIT fields before using this option.
+     * See https://docs.coveo.com/en/1707#fields-domain
      */
     createFields?: boolean;
 }

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

@@ -0,0 +1,11 @@
+import PlatformClient from '@coveord/platform-client';
+import { BatchUpdateDocumentsFromFiles, FailedUploadCallback, SuccessfulUploadCallback } from '../index';
+import type { UploadStrategy } from '../uploadStrategy';
+export declare class BatchUploadDocumentsFromFilesReturn {
+    private internalPromise;
+    private consumer;
+    constructor(platformClient: PlatformClient, strategy: UploadStrategy, filesOrDirectories: string[], options?: BatchUpdateDocumentsFromFiles);
+    onBatchUpload(cb: SuccessfulUploadCallback): this;
+    onBatchError(cb: FailedUploadCallback): this;
+    batch(): Promise<void>;
+}

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

@@ -0,0 +1,69 @@
+import { SourceVisibility } from '@coveord/platform-client';
+import { PlatformUrlOptions } from '../environment';
+import { SecurityIdentity } from './securityIdenty';
+import { BatchUpdateDocuments, BatchUpdateDocumentsFromFiles, BatchUpdateDocumentsOptions } from '../interfaces';
+import { BatchUploadDocumentsFromFilesReturn } from './batchUploadDocumentsFromFile';
+/**
+ * Manage a catalog source.
+ *
+ * Allows you to create a new catalog source, manage security identities and documents in a Coveo organization.
+ */
+export declare class CatalogSource {
+    private apikey;
+    private organizationid;
+    private platformClient;
+    private options;
+    private static defaultOptions;
+    /**
+     * Creates an instance of CatalogSource.
+     * @param {string} 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 {string} organizationid The Coveo Organization identifier.
+     * @param {PlatformUrlOptions} [opts=CatalogSource.defaultOptions]
+     */
+    constructor(apikey: string, organizationid: string, opts?: PlatformUrlOptions);
+    /**
+     * Create a new catalog source
+     * @param name The name of the source to create.
+     * @param sourceVisibility The security option that should be applied to the content of the source. See [Content Security](https://docs.coveo.com/en/1779).
+     * @returns
+     */
+    create(name: string, sourceVisibility: SourceVisibility): Promise<{
+        id: string;
+    }>;
+    get identity(): SecurityIdentity;
+    /**
+     * Manage batches of items in a catalog source.
+     * See [Full Document Update](https://docs.coveo.com/en/l62e0540)
+     * @param sourceId
+     * @param batch
+     * @param {BatchUpdateDocumentsOptions} [{createFields: createFields = true}={}]
+     * @returns
+     */
+    batchUpdateDocuments(sourceId: string, batch: BatchUpdateDocuments, { createFields: createFields }?: BatchUpdateDocumentsOptions): Promise<import("axios").AxiosResponse<any, any>>;
+    /**
+     * Send your catalog data to your catalog source.
+     * See [How to Stream Your Catalog Data to Your Source](https://docs.coveo.com/en/lb4a0344)
+     * @param {string} sourceId
+     * @param {BatchUpdateDocuments} batch
+     * @param {BatchUpdateDocumentsOptions} [{createFields: createFields = true}={}]
+     */
+    batchStreamDocuments(sourceId: string, batch: BatchUpdateDocuments, { createFields: createFields }?: BatchUpdateDocumentsOptions): Promise<void>;
+    /**
+     * Manage batches of items in a catalog source from a list of JSON files. See [Full Document Update Source](https://docs.coveo.com/en/l62e0540)
+     * @param {string} sourceId The unique identifier of the target Push source
+     * @param {string[]} filesOrDirectories A list of JSON files or directories (containing JSON files) from which to extract documents.
+     * @param {BatchUpdateDocumentsFromFiles} options
+     */
+    batchUpdateDocumentsFromFiles(sourceId: string, filesOrDirectories: string[], options?: BatchUpdateDocumentsFromFiles): BatchUploadDocumentsFromFilesReturn;
+    /**
+     * Send your catalog data to your catalog source from a list of JSON files.
+     * See [How to Stream Your Catalog Data to Your Source](https://docs.coveo.com/en/lb4a0344)
+     * @param {string} sourceId The unique identifier of the target Push source
+     * @param {string[]} filesOrDirectories A list of JSON files or directories (containing JSON files) from which to extract documents.
+     * @param {BatchUpdateDocumentsFromFiles} [options]
+     */
+    batchStreamDocumentsFromFiles(sourceId: string, filesOrDirectories: string[], options?: BatchUpdateDocumentsFromFiles): BatchUploadDocumentsFromFilesReturn;
+    private urlBuilder;
+    private fileContainerStrategy;
+    private streamChunkStrategy;
+}

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

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

package/dist/definitions/source/catalog.stream.spec.d.ts

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

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

@@ -0,0 +1,5 @@
+import PlatformClient from '@coveord/platform-client';
+import { AxiosResponse } from 'axios';
+import { BatchUpdateDocuments } from '../interfaces';
+import { UploadStrategy } from '../uploadStrategy';
+export declare function uploadBatch(platformClient: PlatformClient, strategy: UploadStrategy, batch: BatchUpdateDocuments, createFields?: boolean): Promise<AxiosResponse>;

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

@@ -4,8 +4,8 @@ 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';
+import { BatchUpdateDocuments, BatchUpdateDocumentsFromFiles, BatchUpdateDocumentsOptions } from '../interfaces';
+import { BatchUploadDocumentsFromFilesReturn } from './batchUploadDocumentsFromFile';
 export declare type SourceStatus = 'REBUILD' | 'REFRESH' | 'INCREMENTAL' | 'IDLE';
 /**
  * Manage a push source.
@@ -87,7 +87,7 @@ export declare class PushSource {
      * @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[], options?: BatchUpdateDocumentsFromFiles): BatchUpdateDocumentsFromFilesReturn;
+    batchUpdateDocumentsFromFiles(sourceID: string, filesOrDirectories: string[], options?: BatchUpdateDocumentsFromFiles): BatchUploadDocumentsFromFilesReturn;
     /**
      * 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
@@ -110,15 +110,8 @@ export declare class PushSource {
      * @returns
      */
     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();
     createFields(analyser: FieldAnalyser): Promise<void>;
-    private getFileContainerAxiosConfig;
-    private get documentsRequestHeaders();
-    private get authorizationHeader();
-    private createFileContainer;
-    private uploadContentToFileContainer;
-    private pushFileContainerContent;
+    private urlBuilder;
+    private fileContainerStrategy;
 }

package/dist/definitions/uploadStrategy/fileContainerStrategy.d.ts

@@ -0,0 +1,23 @@
+import { AxiosRequestConfig } from 'axios';
+import { BatchUpdateDocuments } from '../interfaces';
+import { UploadStrategy } from './strategy';
+import { URLBuilder } from '../help/urlUtils';
+export interface FileContainerResponse {
+    uploadUri: string;
+    fileId: string;
+    requiredHeaders: Record<string, string>;
+}
+/**
+ * Upload documents using the [File container](https://docs.coveo.com/en/43/index-content/creating-a-file-container)
+ *
+ * @class FileContainerStrategy
+ * @implements {UploadStrategy}
+ */
+export declare class FileContainerStrategy implements UploadStrategy {
+    private urlBuilder;
+    private documentsAxiosConfig;
+    constructor(urlBuilder: URLBuilder, documentsAxiosConfig: AxiosRequestConfig);
+    upload(batch: BatchUpdateDocuments): Promise<import("axios").AxiosResponse<any, any>>;
+    private createFileContainer;
+    private pushFileContainerContent;
+}

package/dist/definitions/uploadStrategy/index.d.ts

@@ -0,0 +1,3 @@
+export * from './fileContainerStrategy';
+export * from './strategy';
+export * from './streamChunkStrategy';

package/dist/definitions/uploadStrategy/strategy.d.ts

@@ -0,0 +1,16 @@
+import type { AxiosResponse } from 'axios';
+import type { BatchUpdateDocuments } from '../interfaces';
+export interface UploadStrategy {
+    /**
+     * Upload a batch of documents
+     *
+     * @param {BatchUpdateDocuments} batch
+     */
+    upload: (batch: BatchUpdateDocuments) => Promise<AxiosResponse>;
+    /**
+     * Async operation to run once the batch upload is complete
+     *
+     * @memberof UploadStrategy
+     */
+    postUpload?: () => Promise<void>;
+}

package/dist/definitions/uploadStrategy/streamChunkStrategy.d.ts

@@ -0,0 +1,27 @@
+import { AxiosRequestConfig } from 'axios';
+import { BatchUpdateDocuments } from '../interfaces';
+import { UploadStrategy } from './strategy';
+import { StreamUrlBuilder } from '../help/urlUtils';
+export interface StreamResponse {
+    uploadUri: string;
+    fileId: string;
+    requiredHeaders: Record<string, string>;
+    streamId: string;
+}
+/**
+ * Upload documents using the [Stream API](https://docs.coveo.com/en/lb4a0344/coveo-for-commerce/how-to-stream-your-catalog-data-to-your-source)
+ *
+ * @class StreamChunkStrategy
+ * @implements {UploadStrategy}
+ */
+export declare class StreamChunkStrategy implements UploadStrategy {
+    private urlBuilder;
+    private documentsAxiosConfig;
+    private _openedStream;
+    constructor(urlBuilder: StreamUrlBuilder, documentsAxiosConfig: AxiosRequestConfig);
+    upload(batch: BatchUpdateDocuments): Promise<import("axios").AxiosResponse<any, any>>;
+    postUpload(): Promise<any>;
+    openStreamIfNotAlreadyOpen(): Promise<StreamResponse>;
+    closeOpenedStream(): Promise<any>;
+    private requestStreamChunk;
+}

package/dist/definitions/validation/preconditions/apiKeyPrivilege.d.ts

@@ -0,0 +1,3 @@
+import type { PlatformPrivilege } from './platformPrivilege';
+import PlatformClient from '@coveord/platform-client';
+export declare function ensureNecessaryCoveoPrivileges(client: PlatformClient, ...privileges: PlatformPrivilege[]): Promise<void | never>;

package/dist/definitions/validation/preconditions/apiKeyPrivilege.spec.d.ts

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

package/dist/definitions/validation/preconditions/platformPrivilege.d.ts

@@ -0,0 +1,7 @@
+import type { PrivilegeModel } from '@coveord/platform-client';
+export interface PlatformPrivilege {
+    models: PrivilegeModel[];
+    unsatisfiedConditionMessage: string;
+}
+export declare const readFieldsPrivilege: PlatformPrivilege;
+export declare const writeFieldsPrivilege: PlatformPrivilege;