@coveo/push-api-client 2.8.12 → 3.0.0

package/README.md

@@ -7,11 +7,12 @@ Coveo Push API client
 `npm i @coveo/push-api-client`
 
 ## Features
-* Upload data to both Push and Catalog sources
-* Pre-push document validation
-* Automatic custom field creation
-* Full catalog upload and incremental document update
-* Optimized for large payload uploads
+
+- Upload data to both Push and Catalog sources
+- Pre-push document validation
+- Automatic custom field creation
+- Full catalog upload and incremental document update
+- Optimized for large payload uploads
 
 ## Usage
 
@@ -33,6 +34,7 @@ main();
 ```
 
 You can also upload your data into a catalog source
+
 ```js
 async function main() {
   const source = new CatalogSource('my_api_key', 'my_coveo_organization_id');
@@ -42,7 +44,6 @@ async function main() {
 }
 
 main();
-
 ```
 
 See more examples in the `./samples` folder.

package/dist/APICore.js

@@ -2,38 +2,43 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.APICore = void 0;
 const exponential_backoff_1 = require("exponential-backoff");
-const axios_1 = require("axios");
 class APICore {
     constructor(accessToken) {
         this.accessToken = accessToken;
     }
-    async request(config) {
+    async request(url, config) {
         const req = async () => {
-            const response = await axios_1.default.request(Object.assign(Object.assign({}, config), this.axiosRequestHeaders));
-            if (this.isThrottled(response.status)) {
-                throw response;
-            }
+            const response = await fetch(url, Object.assign(Object.assign({}, config), { headers: Object.assign(Object.assign({}, this.requestHeaders), config.headers) }));
             return response;
         };
         return (0, exponential_backoff_1.backOff)(req, {
             retry: (res) => this.isThrottled(res.status),
         });
     }
+    async requestJson(url, config) {
+        return (await this.request(url, config)).json();
+    }
     async post(url, data = {}) {
-        return this.request({ url, data, method: 'post' });
+        return this.requestJson(url, { body: JSON.stringify(data), method: 'post' });
+    }
+    async put(url, data = {}, parse = true) {
+        return this.selectRequester(parse)(url, {
+            body: JSON.stringify(data),
+            method: 'put',
+        });
     }
-    async put(url, data = {}) {
-        return this.request({ url, data, method: 'put' });
+    selectRequester(parse) {
+        return parse ? this.requestJson : this.request;
     }
-    async delete(url) {
-        return this.request({ url, method: 'delete' });
+    async delete(url, parse = true) {
+        return this.selectRequester(parse)(url, { method: 'delete' });
     }
-    get axiosRequestHeaders() {
+    get requestHeaders() {
         const authorizationHeader = {
             Authorization: `Bearer ${this.accessToken}`,
         };
         const documentsRequestHeaders = Object.assign(Object.assign({}, authorizationHeader), { 'Content-Type': 'application/json', Accept: 'application/json' });
-        return { headers: documentsRequestHeaders };
+        return documentsRequestHeaders;
     }
     isThrottled(status) {
         return status === 429;

package/dist/APICore.js.map

@@ -1 +1 @@
-{"version":3,"file":"APICore.js","sourceRoot":"","sources":["../src/APICore.ts"],"names":[],"mappings":";;;AAAA,6DAA4C;AAC5C,iCAA+D;AAE/D,MAAa,OAAO;IAClB,YAA2B,WAAmB;QAAnB,gBAAW,GAAX,WAAW,CAAQ;IAAG,CAAC;IAE1C,KAAK,CAAC,OAAO,CACnB,MAA0B;QAE1B,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;YACrB,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,OAAO,iCAC/B,MAAM,GACN,IAAI,CAAC,mBAAmB,EAC3B,CAAC;YAEH,IAAI,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBACrC,MAAM,QAAQ,CAAC;aAChB;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC;QAEF,OAAO,IAAA,6BAAO,EAAC,GAAG,EAAE;YAClB,KAAK,EAAE,CAAC,GAAqB,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC;SAC/D,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,IAAI,CACf,GAAW,EACX,OAAgB,EAAE;QAElB,OAAO,IAAI,CAAC,OAAO,CAAI,EAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC;IACtD,CAAC;IAEM,KAAK,CAAC,GAAG,CACd,GAAW,EACX,OAAgB,EAAE;QAElB,OAAO,IAAI,CAAC,OAAO,CAAC,EAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAC,CAAC,CAAC;IAClD,CAAC;IAEM,KAAK,CAAC,MAAM,CAAI,GAAW;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,EAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAC,CAAC,CAAC;IAC/C,CAAC;IAED,IAAY,mBAAmB;QAC7B,MAAM,mBAAmB,GAAG;YAC1B,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE;SAC5C,CAAC;QAEF,MAAM,uBAAuB,mCACxB,mBAAmB,KACtB,cAAc,EAAE,kBAAkB,EAClC,MAAM,EAAE,kBAAkB,GAC3B,CAAC;QAEF,OAAO,EAAC,OAAO,EAAE,uBAAuB,EAAC,CAAC;IAC5C,CAAC;IAEO,WAAW,CAAC,MAAc;QAChC,OAAO,MAAM,KAAK,GAAG,CAAC;IACxB,CAAC;CACF;AA1DD,0BA0DC"}
+{"version":3,"file":"APICore.js","sourceRoot":"","sources":["../src/APICore.ts"],"names":[],"mappings":";;;AAAA,6DAA4C;AAE5C,MAAa,OAAO;IAClB,YAA2B,WAAmB;QAAnB,gBAAW,GAAX,WAAW,CAAQ;IAAG,CAAC;IAE1C,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,MAAmB;QACpD,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;YACrB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,kCAC3B,MAAM,KACT,OAAO,kCAAM,IAAI,CAAC,cAAc,GAAK,MAAM,CAAC,OAAO,KACnD,CAAC;YACH,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC;QAEF,OAAO,IAAA,6BAAO,EAAC,GAAG,EAAE;YAClB,KAAK,EAAE,CAAC,GAAa,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC;SACvD,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,WAAW,CAAI,GAAW,EAAE,MAAmB;QAC3D,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,EAAgB,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,IAAI,CAAI,GAAW,EAAE,OAAgB,EAAE;QAClD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,EAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC;IAC7E,CAAC;IAMM,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,OAAgB,EAAE,EAAE,KAAK,GAAG,IAAI;QAC/D,OAAO,IAAI,CAAC,eAAe,CAAI,KAAK,CAAC,CAAC,GAAG,EAAE;YACzC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAC1B,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;IACL,CAAC;IAEO,eAAe,CAAI,KAAc;QACvC,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,WAAc,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACpD,CAAC;IAKM,KAAK,CAAC,MAAM,CAAI,GAAW,EAAE,KAAK,GAAG,IAAI;QAC9C,OAAO,IAAI,CAAC,eAAe,CAAI,KAAK,CAAC,CAAC,GAAG,EAAE,EAAC,MAAM,EAAE,QAAQ,EAAC,CAAC,CAAC;IACjE,CAAC;IAED,IAAY,cAAc;QACxB,MAAM,mBAAmB,GAAG;YAC1B,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE;SAC5C,CAAC;QAEF,MAAM,uBAAuB,mCACxB,mBAAmB,KACtB,cAAc,EAAE,kBAAkB,EAClC,MAAM,EAAE,kBAAkB,GAC3B,CAAC;QAEF,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAEO,WAAW,CAAC,MAAc;QAChC,OAAO,MAAM,KAAK,GAAG,CAAC;IACxB,CAAC;CACF;AAhED,0BAgEC"}

package/dist/definitions/APICore.d.ts

@@ -1,11 +1,18 @@
-import { AxiosResponse } from 'axios';
+import type { Response } from 'undici';
 export declare class APICore {
     private accessToken;
     constructor(accessToken: string);
     private request;
-    post<T>(url: string, data?: unknown): Promise<AxiosResponse<T>>;
-    put<T>(url: string, data?: unknown): Promise<AxiosResponse<T>>;
-    delete<T>(url: string): Promise<AxiosResponse<T>>;
-    private get axiosRequestHeaders();
+    private requestJson;
+    post<T>(url: string, data?: unknown): Promise<T>;
+    put<T>(url: string): Promise<T>;
+    put<T>(url: string, data: unknown): Promise<T>;
+    put<T>(url: string, data: unknown, parse: true): Promise<T>;
+    put(url: string, data: unknown, parse: false): Promise<Response>;
+    private selectRequester;
+    delete<T>(url: string): Promise<T>;
+    delete(url: string, parse: false): Promise<Response>;
+    delete<T>(url: string, parse: true): Promise<T>;
+    private get requestHeaders();
     private isThrottled;
 }

package/dist/definitions/document.d.ts

@@ -1,32 +1,4 @@
-export type SecurityIdentityType = 'UNKNOWN' | 'USER' | 'GROUP' | 'VIRTUAL_GROUP';
-/**
- * A security identity. See https://docs.coveo.com/en/1719 for more information.
- */
-export interface SecurityIdentity {
-    /**
-     * The name of the security identity.
-     *
-     * Examples:
-     *  - `asmith@example.com`
-     *  - `SampleTeam2`
-     */
-    identity: string;
-    /**
-     * The type of the identity.
-     * Valid values:
-     * - `UNKNOWN`
-     * - `USER` : Defines a single user.
-     * - `GROUP` : Defines an existing group of identities within the indexed system. Individual members of this group can be of any valid identity Type (USER, GROUP, or VIRTUAL_GROUP).
-     * - `VIRTUAL_GROUP` : Defines a group that doesn't exist within the indexed system. Mechanically, a `VIRTUAL_GROUP` is identical to a `GROUP`.
-     */
-    identityType: SecurityIdentityType;
-    /**
-     * The security identity provider through which the security identity is updated.
-     *
-     * Defaults to the first security identity provider associated with the target Push source.
-     */
-    securityProvider?: string;
-}
+import { PermissionLevel, PermissionSet } from '@coveo/platform-client';
 type BaseMetadataValue = string | string[] | number | number[] | boolean;
 type DictionaryMetadataValue = Record<string, BaseMetadataValue>;
 export type MetadataValue = BaseMetadataValue | DictionaryMetadataValue;
@@ -137,22 +109,7 @@ export interface Document {
      *
      * See https://docs.coveo.com/en/107 for more information.
      */
-    permissions?: {
-        /**
-         * Whether to allow anonymous users in this permission set.
-         *
-         * Default value is false.
-         */
-        allowAnonymous: boolean;
-        /**
-         * The list of allowed permissions for this permission set.
-         */
-        allowedPermissions?: SecurityIdentity[];
-        /**
-         * The list of denied permissions for this permission set.
-         */
-        deniedPermissions?: SecurityIdentity[];
-    };
+    permissions?: Array<PermissionSet | PermissionLevel>;
     /**
      * The file extension of the data you're pushing.
      *

package/dist/definitions/documentBuilder.d.ts

@@ -1,12 +1,13 @@
 import { CompressionType, Document, Metadata, MetadataValue } from './document';
-import { SecurityIdentityBuilder } from './securityIdentityBuilder';
 import { Transformer } from './validation/transformers/transformer';
+import { PermissionSetBuilder } from './permissionSetBuilder';
 /**
  * Utility class to build a {@link Document}.
  */
 export declare class DocumentBuilder {
     private uri;
     private doc;
+    private permissions;
     /**
      *
      * @param uri The URI of the document. See {@link Document.uri}
@@ -90,23 +91,27 @@ export declare class DocumentBuilder {
      */
     withMetadata(metadata: Metadata, metadataKeyTransformer?: Transformer): this;
     /**
-     * Set allowed identities on the document. See {@link Document.permissions}
-     * @param securityIdentityBuilder
-     * @returns
-     */
-    withAllowedPermissions(securityIdentityBuilder: SecurityIdentityBuilder): this;
-    /**
-     * Set denied identities on the document. See {@link Document.permissions}
-     * @param securityIdentityBuilder
-     * @returns
+     * Set a permission set on the document
+     * Multiple permission sets can be combined.
+     *
+     * See [Simple Permission Model Definition Examples](https://docs.coveo.com/en/107)
      */
-    withDeniedPermissions(securityIdentityBuilder: SecurityIdentityBuilder): this;
+    withPermissionSet(permissionSetBuilder: PermissionSetBuilder): this;
     /**
-     * Set allowAnonymous for permissions on the document. See {@link Document.permissions}
-     * @param allowAnonymous
-     * @returns
+     * Set a permission level on the document
+     * Multiple permission levels can be added to the document. In this case, the order at which this method is called will influence the permission hierarchy.
+     *
+     * Consider the following example:
+     * ```
+     *  doc.withPermissionLevel('level1', [setA])
+     *     .withPermissionLevel('level2', [setB, setC])
+     * ```
+     *
+     * Permission sets from level1 (`setA`) will supersed the ones from level2 (`setB` and `setC`).
+     *
+     * See [Complex Permission Model Definition](https://docs.coveo.com/en/25/index-content/complex-permission-model-definition-example)
      */
-    withAllowAnonymousUsers(allowAnonymous: boolean): this;
+    withPermissionLevel(permissionLevelName: string, permissionSetBuilders: PermissionSetBuilder[]): this;
     build(): Document;
     /**
      * Marshal the document into a JSON format accepted by the push API.
@@ -114,28 +119,7 @@ export declare class DocumentBuilder {
      */
     marshal(): {
         documentId: string;
-        permissions?: undefined;
-        compressedBinaryData?: {
-            compressionType: CompressionType;
-            data: string;
-        } | undefined;
-        compressionType?: undefined;
-        title: string;
-        clickableUri?: string | undefined;
-        author?: string | undefined;
-        date?: string | undefined;
-        modifiedDate?: string | undefined;
-        permanentId?: string | undefined;
-        parentId?: string | undefined;
-        data?: string | undefined;
-        fileExtension?: string | undefined;
-    } | {
-        documentId: string;
-        permissions: {
-            allowAnonymous: boolean;
-            allowedPermissions: import("./document").SecurityIdentity[];
-            deniedPermissions: import("./document").SecurityIdentity[];
-        }[];
+        permissions?: (import("@coveo/platform-client").PermissionSet | import("@coveo/platform-client").PermissionLevel)[] | undefined;
         compressedBinaryData?: {
             compressionType: CompressionType;
             data: string;
@@ -143,21 +127,11 @@ export declare class DocumentBuilder {
         compressionType?: undefined;
         title: string;
         clickableUri?: string | undefined;
-        author?: string | undefined;
-        date?: string | undefined;
-        modifiedDate?: string | undefined;
-        permanentId?: string | undefined;
-        parentId?: string | undefined;
-        data?: string | undefined;
-        fileExtension?: string | undefined;
-    } | {
-        documentId: string;
-        permissions?: undefined;
-        compressedBinaryData: string;
-        compressionType: CompressionType;
-        title: string;
-        clickableUri?: string | undefined;
-        author?: string | undefined;
+        author?: string | undefined; /**
+         * Set the data of the document. See {@link Document.data}
+         * @param data
+         * @returns
+         */
         date?: string | undefined;
         modifiedDate?: string | undefined;
         permanentId?: string | undefined;
@@ -166,16 +140,16 @@ export declare class DocumentBuilder {
         fileExtension?: string | undefined;
     } | {
         documentId: string;
-        permissions: {
-            allowAnonymous: boolean;
-            allowedPermissions: import("./document").SecurityIdentity[];
-            deniedPermissions: import("./document").SecurityIdentity[];
-        }[];
+        permissions?: (import("@coveo/platform-client").PermissionSet | import("@coveo/platform-client").PermissionLevel)[] | undefined;
         compressedBinaryData: string;
         compressionType: CompressionType;
         title: string;
         clickableUri?: string | undefined;
-        author?: string | undefined;
+        author?: string | undefined; /**
+         * Set the data of the document. See {@link Document.data}
+         * @param data
+         * @returns
+         */
         date?: string | undefined;
         modifiedDate?: string | undefined;
         permanentId?: string | undefined;
@@ -191,5 +165,4 @@ export declare class DocumentBuilder {
     private generatePermanentId;
     private validateDateAndReturnValidDate;
     private validateCompressedBinaryData;
-    private setPermission;
 }

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

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+import { PrimitivesValues } from '@coveo/bueno';
 import { PathLike } from 'fs';
 import { PushApiClientBaseError } from './baseError';
 export declare class NotAFileError extends PushApiClientBaseError {
@@ -11,7 +12,7 @@ export declare class NotAJsonFileError extends PushApiClientBaseError {
 }
 export declare class InvalidDocument extends PushApiClientBaseError {
     name: string;
-    constructor(p: PathLike, explanation: string);
+    constructor(p: PathLike, doc: Record<string, PrimitivesValues>, explanation: string);
 }
 export declare class UnsupportedAttribute extends PushApiClientBaseError {
     name: string;

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

@@ -1,5 +1,5 @@
 import { BatchUpdateDocuments, UploadBatchCallbackData, ConcurrentProcessing, ParseDocumentOptions } from '../interfaces';
-import { AxiosResponse } from 'axios';
+import type { Response } from 'undici';
 export type SuccessfulUploadCallback = (data: UploadBatchCallbackData) => void;
 export type FailedUploadCallback = (err: unknown, value: UploadBatchCallbackData) => void;
 /**
@@ -15,10 +15,10 @@ export declare class FileConsumer {
     private cbFail;
     /**
      * Creates an instance of FileConsumer.
-     * @param {(batch: BatchUpdateDocuments) => Promise<AxiosResponse>} upload the upload operation to apply to every document batch
+     * @param {(batch: BatchUpdateDocuments) => Promise<Response>} upload the upload operation to apply to every document batch
      * @param {Required<ConcurrentProcessing>} processingConfig
      */
-    constructor(upload: (batch: BatchUpdateDocuments) => Promise<AxiosResponse>, processingConfig: Required<ConcurrentProcessing>);
+    constructor(upload: (batch: BatchUpdateDocuments) => Promise<Response>, processingConfig: Required<ConcurrentProcessing>);
     consume(files: string[], options?: ParseDocumentOptions): Promise<void>;
     onSuccess(callback: SuccessfulUploadCallback): void;
     onError(callback: FailedUploadCallback): void;

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

@@ -1,9 +1,8 @@
-import { AxiosRequestConfig } from 'axios';
+import type { Response } from 'undici';
 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;
+export declare const uploadContentToFileContainer: (fileContainer: FileContainerResponse, batch: BatchUpdateDocuments) => Promise<Response>;

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

@@ -1 +1 @@
-export {};
+import 'fetch-undici-polyfill';

package/dist/definitions/index.d.ts

@@ -1,7 +1,6 @@
 export * from './document';
 export * from './validation/transformers/transformer';
 export * as errors from './errors';
-export { Source } from './source/source';
 export { PushSource } from './source/push';
 export { CatalogSource } from './source/catalog';
 export { SuccessfulUploadCallback, FailedUploadCallback, } from './help/fileConsumer';
@@ -11,4 +10,5 @@ export { DocumentBuilder } from './documentBuilder';
 export * from './securityIdentityBuilder';
 export { PlatformEnvironment, Region, PlatformUrlOptions } from './environment';
 export { SourceVisibility } from '@coveo/platform-client';
+export { PermissionSetBuilder } from './permissionSetBuilder';
 export { parseAndGetDocumentBuilderFromJSONDocument } from './validation/parseFile';

package/dist/definitions/interfaces.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import type { AxiosResponse } from 'axios';
+import type { Response } from 'undici';
 import { PathLike } from 'fs';
 import type { DocumentBuilder } from './documentBuilder';
 import type { Transformer } from './validation/transformers/transformer';
@@ -23,13 +23,13 @@ export interface UploadProgress {
  * @param {string[]} files Files from which the documentBuilders were generated
  * @param {DocumentBuilder[]} batch List of the uploaded DocumentBuilders
  * @param {UploadProgress} progress Progress of the upload process
- * @param {AxiosResponse} res Axios response
+ * @param {Response} res fetch response
  */
 export interface UploadBatchCallbackData {
     files: string[];
     batch: DocumentBuilder[];
     progress?: UploadProgress;
-    res?: AxiosResponse;
+    res?: Response;
 }
 export interface BatchUpdateDocumentsOptions {
     /**

package/dist/definitions/permissionSetBuilder.d.ts

@@ -0,0 +1,34 @@
+import { PermissionSet } from '@coveo/platform-client';
+import { SecurityIdentityBuilder } from './securityIdentityBuilder';
+export type PermissionSection = keyof Pick<PermissionSet, 'allowedPermissions' | 'deniedPermissions'>;
+export declare class PermissionSetBuilder {
+    private permissionSet;
+    /**
+     * Builds a Permission Set Model
+     *
+     * See[Simple Permission Model Definition](https://docs.coveo.com/en/107/index-content/simple-permission-model-definition-examples)
+     * @param {boolean} allowAnonymous Whether to allow anonymous users in this permission set
+     */
+    constructor(allowAnonymous: boolean);
+    /**
+     * Set allowed identities on the document. See {@link PermissionSet}
+     *
+     * When the {@link PermissionsSetBuilder} class is instanciated with `allowAnonymous` property set to `true`, calling this method is redundant, and can therefore be omitted.
+     * @param securityIdentityBuilder The allowed security identities to add to the permission set
+     * @returns
+     */
+    withAllowedPermissions(securityIdentityBuilder: SecurityIdentityBuilder): this;
+    /**
+     * Set denied identities on the document. See {@link PermissionSet}
+     *
+     * @param securityIdentityBuilder The denied security identities to add to the permission set
+     * @returns
+     */
+    withDeniedPermissions(securityIdentityBuilder: SecurityIdentityBuilder): this;
+    /**
+     * Build and return the security identity or identities.
+     * @returns
+     */
+    build(): PermissionSet;
+    private setPermission;
+}

package/dist/definitions/permissionSetBuilder.spec.d.ts

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

package/dist/definitions/securityIdentityBuilder.d.ts

@@ -1,12 +1,12 @@
-import { SecurityIdentity, SecurityIdentityType } from './document';
+import { Permission, PermissionIdentityType } from '@coveo/platform-client';
 /**
- * Build a security identity. See {@link SecurityIdentity}.
+ * Build a security identity. See {@link Permission}.
  */
 export interface SecurityIdentityBuilder {
-    build(): SecurityIdentity | SecurityIdentity[];
+    build(): Permission | Permission[];
 }
 /**
- * Build any {@link SecurityIdentityType}.
+ * Build any {@link PermissionIdentityType}.
  *
  * Instead of using this class directly, use one of:
  * - {@link UserSecurityIdentityBuilder}
@@ -16,81 +16,90 @@ export interface SecurityIdentityBuilder {
 export declare class AnySecurityIdentityBuilder implements SecurityIdentityBuilder {
     private securityIdentity;
     /**
+     * @param identityType  The type of the identity.
+     * Valid values:
+     * - `UNKNOWN`
+     * - `USER` : Defines a single user.
+     * - `GROUP` : Defines an existing group of identities within the indexed system. Individual members of this group can be of any valid identity Type (USER, GROUP, or VIRTUAL_GROUP).
+     * - `VIRTUAL_GROUP` : Defines a group that doesn't exist within the indexed system. Mechanically, a `VIRTUAL_GROUP` is identical to a `GROUP`.
      *
-     * @param identityType
-     * @param identity
-     * @param securityProvider
+     * @param identity The name of the security identity.
+     * Examples:
+     * - `asmith@example.com`
+     * - `SampleTeam2`
+     *
+     * @param securityProvider The security identity provider through which the security identity is updated. Defaults to the first security identity provider associated with the target source.
      */
-    constructor(identityType: SecurityIdentityType, identity: string, securityProvider?: string);
+    constructor(identityType: PermissionIdentityType, identity: string, securityProvider?: string);
     /**
      * Build and return the security identity.
      * @returns
      */
-    build(): SecurityIdentity;
+    build(): Permission;
 }
 /**
  * Build a security identity of type `USER`.
  *
- * Typically used in conjunction with {@link DocumentBuilder.withAllowedPermissions} or {@link DocumentBuilder.withDeniedPermissions}.
+ * Typically used in conjunction with {@link PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
  *
- * See {@link SecurityIdentity}.
+ * See {@link Permission}.
  */
 export declare class UserSecurityIdentityBuilder implements SecurityIdentityBuilder {
     private user;
     private securityProvider;
     /**
      * Pass either a single user, or an array of user to create multiple identities.
-     * @param user
-     * @param securityProvider
+     * @param {(string | string[])} user  The user identity or identities
+     * @param {string} [securityProvider='Email Security Provider'] The security identity provider through which the security identity is updated. Defaults to the first security identity provider associated with the target source.
      */
     constructor(user: string | string[], securityProvider?: string);
     /**
      * Build and return the security identity or identities.
      * @returns
      */
-    build(): SecurityIdentity | SecurityIdentity[];
+    build(): Permission | Permission[];
 }
 /**
  * Build a security identity of type `GROUP`.
  *
- * Typically used in conjunction with {@link DocumentBuilder.withAllowedPermissions} or {@link DocumentBuilder.withDeniedPermissions}.
+ * Typically used in conjunction with {@link PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
  *
- * See {@link SecurityIdentity}.
+ * See {@link Permission}.
  */
 export declare class GroupSecurityIdentityBuilder implements SecurityIdentityBuilder {
     private group;
     private securityProvider?;
     /**
      * Pass either a single `group`, or an array of `group` to create multiple identities.
-     * @param group
-     * @param securityProvider
+     * @param {(string | string[])} group
+     * @param {string} [securityProvider] The security identity provider through which the security identity is updated. Defaults to the first security identity provider associated with the target source.
      */
     constructor(group: string | string[], securityProvider?: string | undefined);
     /**
      * Build and return the security identity or identities.
      * @returns
      */
-    build(): SecurityIdentity | SecurityIdentity[];
+    build(): Permission | Permission[];
 }
 /**
  * Build a security identity of type `VIRTUAL_GROUP`.
  *
- * Typically used in conjunction with {@link DocumentBuilder.withAllowedPermissions} or {@link DocumentBuilder.withDeniedPermissions}.
+ * Typically used in conjunction with {@link PermissionSetBuilder.withAllowedPermissions} or {@link PermissionSetBuilder.withDeniedPermissions}.
  *
- * See {@link SecurityIdentity}.
+ * See {@link Permission}.
  */
 export declare class VirtualGroupSecurityIdentityBuilder implements SecurityIdentityBuilder {
     private virtualGroup;
     private securityProvider?;
     /**
      * Pass either a single `virtualGroup`, or an array of `virtualGroup` to create multiple identities.
-     * @param group
-     * @param securityProvider
+     * @param {(string | string[])} virtualGroup
+     * @param {string} [securityProvider] The security identity provider through which the security identity is updated. Defaults to the first security identity provider associated with the target source.
      */
     constructor(virtualGroup: string | string[], securityProvider?: string | undefined);
     /**
      * Build and return the security identity or identities.
      * @returns
      */
-    build(): SecurityIdentity | SecurityIdentity[];
+    build(): Permission | Permission[];
 }

package/dist/definitions/securityIdentityBuilder.spec.d.ts

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

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

@@ -1,3 +1,4 @@
+import 'fetch-undici-polyfill';
 import { SourceVisibility } from '@coveo/platform-client';
 import { PlatformUrlOptions } from '../environment';
 import { SecurityIdentity } from './securityIdenty';
@@ -39,7 +40,7 @@ export declare class CatalogSource {
      * @param {BatchUpdateDocumentsOptions}
      * @returns
      */
-    batchUpdateDocuments(sourceId: string, batch: BatchUpdateDocuments, options?: BatchUpdateDocumentsOptions): Promise<import("axios").AxiosResponse<any, any>>;
+    batchUpdateDocuments(sourceId: string, batch: BatchUpdateDocuments, options?: BatchUpdateDocumentsOptions): Promise<import("undici").Response>;
     /**
      * Send your catalog data to your catalog source.
      * See [How to Stream Your Catalog Data to Your Source](https://docs.coveo.com/en/lb4a0344)

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

@@ -1,11 +1,11 @@
 /// <reference types="node" />
 import PlatformClient from '@coveo/platform-client';
-import { AxiosResponse } from 'axios';
+import type { Response } from 'undici';
 import { APICore } from '../APICore';
 import { DocumentBuilder } from '../documentBuilder';
 import { BatchUpdateDocuments, BatchUpdateDocumentsFromFiles, BatchUpdateDocumentsOptions } from '../interfaces';
 import { UploadStrategy } from '../uploadStrategy';
 import { BatchUploadDocumentsFromFilesReturn } from './batchUploadDocumentsFromFile';
-export declare function uploadDocument(platformClient: PlatformClient, docBuilder: DocumentBuilder, addURL: URL, api: APICore, options?: BatchUpdateDocumentsOptions): Promise<AxiosResponse<unknown, any>>;
-export declare function uploadBatch(platformClient: PlatformClient, strategy: UploadStrategy, batch: BatchUpdateDocuments, options?: BatchUpdateDocumentsOptions): Promise<AxiosResponse>;
+export declare function uploadDocument(platformClient: PlatformClient, docBuilder: DocumentBuilder, addURL: URL, api: APICore, options?: BatchUpdateDocumentsOptions): Promise<Response>;
+export declare function uploadBatch(platformClient: PlatformClient, strategy: UploadStrategy, batch: BatchUpdateDocuments, options?: BatchUpdateDocumentsOptions): Promise<Response>;
 export declare function uploadBatchFromFile(platformClient: PlatformClient, strategy: UploadStrategy, filesOrDirectories: string[], options?: BatchUpdateDocumentsFromFiles): BatchUploadDocumentsFromFilesReturn;