@coveo/push-api-client 3.0.122 → 3.0.124

package/dist/definitions/documentBuilder.d.ts

@@ -1,168 +1,168 @@
-import { CompressionType, Document, Metadata, MetadataValue } from './document';
-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}
-     * @param title The title of the document. See {@link Document.title}
-     */
-    constructor(uri: string, title: string);
-    /**
-     * Set the data of the document. See {@link Document.data}
-     * @param data
-     * @returns
-     */
-    withData(data: string): this;
-    /**
-     * Set the date of the document. See {@link Document.date}
-     * @param date
-     * @returns
-     */
-    withDate(date: Date | string | number): this;
-    /**
-     * Set the modified date of the document. See {@link Document.modifiedDate}
-     * @param date
-     * @returns
-     */
-    withModifiedDate(date: Date | string | number): this;
-    /**
-     * Set the permanentID of the document. See {@link Document.permanentId}
-     * @param permanentID
-     * @returns
-     */
-    withPermanentId(permanentID: string): this;
-    /**
-     * Set the base64 encoded, compressed binary data of the document. See {@link Document.compressedBinaryData}
-     * @param data
-     * @param compressionType
-     * @returns
-     */
-    withCompressedBinaryData(data: string, compressionType: CompressionType): this;
-    /**
-     * Set the file extension on the document. See {@link Document.fileExtension}
-     * @param extension
-     * @returns
-     */
-    withFileExtension(extension: string): this;
-    /**
-     * Set the parentID on the document. See {@link Document.parentId}
-     * @param id
-     * @returns
-     */
-    withParentID(id: string): this;
-    /**
-     * Set the clickableURI on the document. See {@link Document.clickableUri}
-     * @param clickURI
-     * @returns
-     */
-    withClickableUri(clickURI: string): this;
-    /**
-     * Set the author on the document. See {@link Document.author}
-     * @param author
-     * @returns
-     */
-    withAuthor(author: string): this;
-    /**
-     * Add a single metadata key and value pair on the document. See {@link Document.metadata}
-     * @param {string} key
-     * @param {MetadataValue} value
-     * @param {Transformer} [metadataKeyTransformer=BuiltInTransformers.identity] The {@link Transformer} to apply to the metadata key.
-     * If not specified, no transformation will be applied to the metadata key.
-     *
-     * For a list of built-in transformers, use {@link BuiltInTransformers}.
-     * @returns
-     */
-    withMetadataValue(key: string, value: MetadataValue, keyTransformer?: Transformer): this;
-    /**
-     * Set metadata on the document. See {@link Document.metadata}
-     * @param {Metadata} metadata
-     * @param {Transformer} [metadataKeyTransformer=BuiltInTransformers.identity] The {@link Transformer} to apply to all the document metadata keys.
-     * If not specified, no transformation will be applied to the metadata keys.
-     *
-     * For a list of built-in transformers, use {@link BuiltInTransformers}.
-     * @returns
-     */
-    withMetadata(metadata: Metadata, metadataKeyTransformer?: Transformer): this;
-    /**
-     * 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)
-     */
-    withPermissionSet(permissionSetBuilder: PermissionSetBuilder): this;
-    /**
-     * 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)
-     */
-    withPermissionLevel(permissionLevelName: string, permissionSetBuilders: PermissionSetBuilder[]): this;
-    build(): Document;
-    /**
-     * Marshal the document into a JSON format accepted by the push API.
-     * @returns
-     */
-    marshal(): {
-        documentId: string;
-        permissions?: (import("@coveo/platform-client").PermissionSet | import("@coveo/platform-client").PermissionLevel)[] | undefined;
-        compressedBinaryData?: {
-            compressionType: CompressionType;
-            data: string;
-        } | undefined;
-        compressionType?: undefined;
-        title: string;
-        clickableUri?: string | undefined;
-        author?: string | undefined; /**
-         * Set the data of the document. See {@link Document.data}
-         * @param data
-         * @returns
-         */
-        date?: string | undefined;
-        modifiedDate?: string | undefined;
-        parentId?: string | undefined;
-        data?: string | undefined;
-        fileExtension?: string | undefined;
-        permanentid: string | undefined;
-    } | {
-        documentId: string;
-        permissions?: (import("@coveo/platform-client").PermissionSet | import("@coveo/platform-client").PermissionLevel)[] | undefined;
-        compressedBinaryData: string;
-        compressionType: CompressionType;
-        title: string;
-        clickableUri?: string | undefined;
-        author?: string | undefined; /**
-         * Set the data of the document. See {@link Document.data}
-         * @param data
-         * @returns
-         */
-        date?: string | undefined;
-        modifiedDate?: string | undefined;
-        parentId?: string | undefined;
-        data?: string | undefined;
-        fileExtension?: string | undefined;
-        permanentid: string | undefined;
-    };
-    private marshalDocumentId;
-    private marshalMetadata;
-    private marshalCompressedBinaryData;
-    private marshalPermissions;
-    private validateAndFillMissing;
-    private generatePermanentId;
-    private validateDateAndReturnValidDate;
-    private validateCompressedBinaryData;
-}
+import { CompressionType, Document, Metadata, MetadataValue } from './document';
+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}
+     * @param title The title of the document. See {@link Document.title}
+     */
+    constructor(uri: string, title: string);
+    /**
+     * Set the data of the document. See {@link Document.data}
+     * @param data
+     * @returns
+     */
+    withData(data: string): this;
+    /**
+     * Set the date of the document. See {@link Document.date}
+     * @param date
+     * @returns
+     */
+    withDate(date: Date | string | number): this;
+    /**
+     * Set the modified date of the document. See {@link Document.modifiedDate}
+     * @param date
+     * @returns
+     */
+    withModifiedDate(date: Date | string | number): this;
+    /**
+     * Set the permanentID of the document. See {@link Document.permanentId}
+     * @param permanentID
+     * @returns
+     */
+    withPermanentId(permanentID: string): this;
+    /**
+     * Set the base64 encoded, compressed binary data of the document. See {@link Document.compressedBinaryData}
+     * @param data
+     * @param compressionType
+     * @returns
+     */
+    withCompressedBinaryData(data: string, compressionType: CompressionType): this;
+    /**
+     * Set the file extension on the document. See {@link Document.fileExtension}
+     * @param extension
+     * @returns
+     */
+    withFileExtension(extension: string): this;
+    /**
+     * Set the parentID on the document. See {@link Document.parentId}
+     * @param id
+     * @returns
+     */
+    withParentID(id: string): this;
+    /**
+     * Set the clickableURI on the document. See {@link Document.clickableUri}
+     * @param clickURI
+     * @returns
+     */
+    withClickableUri(clickURI: string): this;
+    /**
+     * Set the author on the document. See {@link Document.author}
+     * @param author
+     * @returns
+     */
+    withAuthor(author: string): this;
+    /**
+     * Add a single metadata key and value pair on the document. See {@link Document.metadata}
+     * @param {string} key
+     * @param {MetadataValue} value
+     * @param {Transformer} [metadataKeyTransformer=BuiltInTransformers.identity] The {@link Transformer} to apply to the metadata key.
+     * If not specified, no transformation will be applied to the metadata key.
+     *
+     * For a list of built-in transformers, use {@link BuiltInTransformers}.
+     * @returns
+     */
+    withMetadataValue(key: string, value: MetadataValue, keyTransformer?: Transformer): this;
+    /**
+     * Set metadata on the document. See {@link Document.metadata}
+     * @param {Metadata} metadata
+     * @param {Transformer} [metadataKeyTransformer=BuiltInTransformers.identity] The {@link Transformer} to apply to all the document metadata keys.
+     * If not specified, no transformation will be applied to the metadata keys.
+     *
+     * For a list of built-in transformers, use {@link BuiltInTransformers}.
+     * @returns
+     */
+    withMetadata(metadata: Metadata, metadataKeyTransformer?: Transformer): this;
+    /**
+     * 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)
+     */
+    withPermissionSet(permissionSetBuilder: PermissionSetBuilder): this;
+    /**
+     * 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)
+     */
+    withPermissionLevel(permissionLevelName: string, permissionSetBuilders: PermissionSetBuilder[]): this;
+    build(): Document;
+    /**
+     * Marshal the document into a JSON format accepted by the push API.
+     * @returns
+     */
+    marshal(): {
+        documentId: string;
+        permissions?: (import("@coveo/platform-client").PermissionSet | import("@coveo/platform-client").PermissionLevel)[] | undefined;
+        compressedBinaryData?: {
+            compressionType: CompressionType;
+            data: string;
+        } | undefined;
+        compressionType?: undefined;
+        title: string;
+        clickableUri?: string | undefined;
+        author?: string | undefined; /**
+         * Set the data of the document. See {@link Document.data}
+         * @param data
+         * @returns
+         */
+        date?: string | undefined;
+        modifiedDate?: string | undefined;
+        parentId?: string | undefined;
+        data?: string | undefined;
+        fileExtension?: string | undefined;
+        permanentid: string | undefined;
+    } | {
+        documentId: string;
+        permissions?: (import("@coveo/platform-client").PermissionSet | import("@coveo/platform-client").PermissionLevel)[] | undefined;
+        compressedBinaryData: string;
+        compressionType: CompressionType;
+        title: string;
+        clickableUri?: string | undefined;
+        author?: string | undefined; /**
+         * Set the data of the document. See {@link Document.data}
+         * @param data
+         * @returns
+         */
+        date?: string | undefined;
+        modifiedDate?: string | undefined;
+        parentId?: string | undefined;
+        data?: string | undefined;
+        fileExtension?: string | undefined;
+        permanentid: string | undefined;
+    };
+    private marshalDocumentId;
+    private marshalMetadata;
+    private marshalCompressedBinaryData;
+    private marshalPermissions;
+    private validateAndFillMissing;
+    private generatePermanentId;
+    private validateDateAndReturnValidDate;
+    private validateCompressedBinaryData;
+}

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

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

package/dist/definitions/environment.d.ts

@@ -1,16 +1,16 @@
-import { Region, Environment } from '@coveo/platform-client';
-export { Region } from '@coveo/platform-client';
-export declare enum PlatformEnvironment {
-    Dev = "dev",
-    Stg = "stg",
-    Hipaa = "hipaa",
-    Prod = "prod"
-}
-export declare const DEFAULT_ENVIRONMENT: PlatformEnvironment.Prod;
-export declare const DEFAULT_REGION: Region.US;
-export type PlatformUrlOptions = {
-    environment?: PlatformEnvironment;
-    region?: Region;
-};
-export declare function platformUrl(options?: PlatformUrlOptions): string;
-export declare function castEnvironmentToPlatformClient(e: PlatformEnvironment): Environment;
+import { Region, Environment } from '@coveo/platform-client';
+export { Region } from '@coveo/platform-client';
+export declare enum PlatformEnvironment {
+    Dev = "dev",
+    Stg = "stg",
+    Hipaa = "hipaa",
+    Prod = "prod"
+}
+export declare const DEFAULT_ENVIRONMENT: PlatformEnvironment.Prod;
+export declare const DEFAULT_REGION: Region.US;
+export type PlatformUrlOptions = {
+    environment?: PlatformEnvironment;
+    region?: Region;
+};
+export declare function platformUrl(options?: PlatformUrlOptions): string;
+export declare function castEnvironmentToPlatformClient(e: PlatformEnvironment): Environment;

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

@@ -1,4 +1,4 @@
-export declare abstract class PushApiClientBaseError extends Error {
-    name: string;
-    constructor(message?: string);
-}
+export declare abstract class PushApiClientBaseError extends Error {
+    name: string;
+    constructor(message?: string);
+}

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

@@ -1,18 +1,18 @@
-import { FieldModel } from '@coveo/platform-client';
-import { Inconsistencies } from '../fieldAnalyser/inconsistencies';
-import { PushApiClientBaseError } from './baseError';
-export declare class FieldTypeInconsistencyError extends PushApiClientBaseError {
-    name: string;
-    constructor(inconsitencies: Inconsistencies);
-}
-export declare class InvalidPermanentId extends PushApiClientBaseError {
-    name: string;
-    constructor(field: FieldModel);
-}
-export declare class UnsupportedFieldError extends PushApiClientBaseError {
-    name: string;
-    static emptyFieldNameReplacer: string;
-    readonly unsupportedFields: [string, string][];
-    constructor(...unsupportedFields: [string, string][]);
-    private get formattedFieldList();
-}
+import { FieldModel } from '@coveo/platform-client';
+import { Inconsistencies } from '../fieldAnalyser/inconsistencies';
+import { PushApiClientBaseError } from './baseError';
+export declare class FieldTypeInconsistencyError extends PushApiClientBaseError {
+    name: string;
+    constructor(inconsitencies: Inconsistencies);
+}
+export declare class InvalidPermanentId extends PushApiClientBaseError {
+    name: string;
+    constructor(field: FieldModel);
+}
+export declare class UnsupportedFieldError extends PushApiClientBaseError {
+    name: string;
+    static emptyFieldNameReplacer: string;
+    readonly unsupportedFields: [string, string][];
+    constructor(...unsupportedFields: [string, string][]);
+    private get formattedFieldList();
+}

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

@@ -1,3 +1,3 @@
-export * from './fieldErrors';
-export * from './privilegeError';
-export * from './validatorErrors';
+export * from './fieldErrors';
+export * from './privilegeError';
+export * from './validatorErrors';

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

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

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

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

package/dist/definitions/fieldAnalyser/fieldAnalyser.d.ts

@@ -1,36 +1,36 @@
-import PlatformClient, { FieldModel } from '@coveo/platform-client';
-import { DocumentBuilder } from '..';
-import { Inconsistencies } from './inconsistencies';
-export type FieldAnalyserReport = {
-    fields: FieldModel[];
-    inconsistencies: Inconsistencies;
-};
-/**
- * Analyse documents to detect type inconsistencies and missing fields in your index.
- *
- */
-export declare class FieldAnalyser {
-    private platformClient;
-    private inconsistencies;
-    private missingFields;
-    private existingFields;
-    constructor(platformClient: PlatformClient);
-    /**
-     * Adds a batch of document builders to the analyser to extract all the missing fields that need to be created in the organization.
-     * This method can be called as many time as needed as it will take into consideration document builders previously added.
-     *
-     * @param {DocumentBuilder[]} batch
-     * @return {*}
-     */
-    add(batch: DocumentBuilder[]): Promise<this>;
-    /**
-     * Returns the analyser report containing the fields to create as well as the type inconsistencies in the documents
-     *
-     * @return {*}  {FieldAnalyserReport}
-     */
-    report(): FieldAnalyserReport;
-    private removeInconsistentFields;
-    private storeMetadata;
-    private ensureExistingFields;
-    private ensurePermanentId;
-}
+import PlatformClient, { FieldModel } from '@coveo/platform-client';
+import { DocumentBuilder } from '..';
+import { Inconsistencies } from './inconsistencies';
+export type FieldAnalyserReport = {
+    fields: FieldModel[];
+    inconsistencies: Inconsistencies;
+};
+/**
+ * Analyse documents to detect type inconsistencies and missing fields in your index.
+ *
+ */
+export declare class FieldAnalyser {
+    private platformClient;
+    private inconsistencies;
+    private missingFields;
+    private existingFields;
+    constructor(platformClient: PlatformClient);
+    /**
+     * Adds a batch of document builders to the analyser to extract all the missing fields that need to be created in the organization.
+     * This method can be called as many time as needed as it will take into consideration document builders previously added.
+     *
+     * @param {DocumentBuilder[]} batch
+     * @return {*}
+     */
+    add(batch: DocumentBuilder[]): Promise<this>;
+    /**
+     * Returns the analyser report containing the fields to create as well as the type inconsistencies in the documents
+     *
+     * @return {*}  {FieldAnalyserReport}
+     */
+    report(): FieldAnalyserReport;
+    private removeInconsistentFields;
+    private storeMetadata;
+    private ensureExistingFields;
+    private ensurePermanentId;
+}

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

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

package/dist/definitions/fieldAnalyser/fieldStore.d.ts

@@ -1,5 +1,5 @@
-import { FieldModel, FieldTypes } from '@coveo/platform-client';
-export declare class FieldStore extends Map<string, FieldTypes> {
-    concat(fieldBuilder: FieldStore): void;
-    marshal(): FieldModel[];
-}
+import { FieldModel, FieldTypes } from '@coveo/platform-client';
+export declare class FieldStore extends Map<string, FieldTypes> {
+    concat(fieldBuilder: FieldStore): void;
+    marshal(): FieldModel[];
+}

package/dist/definitions/fieldAnalyser/fieldUtils.d.ts

@@ -1,6 +1,6 @@
-import PlatformClient, { FieldModel } from '@coveo/platform-client';
-import type { FieldAnalyserReport } from './fieldAnalyser';
-export declare const listAllFieldsFromOrg: (client: PlatformClient, page?: number, fields?: FieldModel[]) => Promise<FieldModel[]>;
-export declare const createFields: (client: PlatformClient, fields: FieldModel[], fieldBatch?: number) => Promise<void>;
-export declare const createFieldsFromReport: (client: PlatformClient, report: FieldAnalyserReport) => Promise<void>;
-export declare const isFieldNameValid: (fieldName: string) => boolean;
+import PlatformClient, { FieldModel } from '@coveo/platform-client';
+import type { FieldAnalyserReport } from './fieldAnalyser';
+export declare const listAllFieldsFromOrg: (client: PlatformClient, page?: number, fields?: FieldModel[]) => Promise<FieldModel[]>;
+export declare const createFields: (client: PlatformClient, fields: FieldModel[], fieldBatch?: number) => Promise<void>;
+export declare const createFieldsFromReport: (client: PlatformClient, report: FieldAnalyserReport) => Promise<void>;
+export declare const isFieldNameValid: (fieldName: string) => boolean;

package/dist/definitions/fieldAnalyser/fieldsUtils.spec.d.ts

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

package/dist/definitions/fieldAnalyser/inconsistencies.d.ts

@@ -1,5 +1,5 @@
-import { FieldTypes } from '@coveo/platform-client';
-export declare class Inconsistencies extends Map<string, Set<FieldTypes>> {
-    constructor();
-    add(fieldName: string, types: FieldTypes[]): this;
-}
+import { FieldTypes } from '@coveo/platform-client';
+export declare class Inconsistencies extends Map<string, Set<FieldTypes>> {
+    constructor();
+    add(fieldName: string, types: FieldTypes[]): this;
+}

package/dist/definitions/fieldAnalyser/inconsistencies.spec.d.ts

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

package/dist/definitions/fieldAnalyser/typeUtils.d.ts

@@ -1,3 +1,3 @@
-import { FieldTypes } from '@coveo/platform-client';
-export declare function getMostEnglobingType(possibleType1: FieldTypes, possibleType2: FieldTypes, acceptedTypeEvolution?: FieldTypes[]): FieldTypes | null;
-export declare function getGuessedTypeFromValue(obj: unknown): FieldTypes;
+import { FieldTypes } from '@coveo/platform-client';
+export declare function getMostEnglobingType(possibleType1: FieldTypes, possibleType2: FieldTypes, acceptedTypeEvolution?: FieldTypes[]): FieldTypes | null;
+export declare function getGuessedTypeFromValue(obj: unknown): FieldTypes;

package/dist/definitions/fieldAnalyser/typeUtils.spec.d.ts

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

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

@@ -1,3 +1,3 @@
-import { PathLike } from 'fs';
-export declare const isJsonFile: (documentPath: PathLike) => boolean;
-export declare const getAllJsonFilesFromEntries: (filesOrDirectories: string[], fileNames?: string[]) => string[];
+import { PathLike } from 'fs';
+export declare const isJsonFile: (documentPath: PathLike) => boolean;
+export declare const getAllJsonFilesFromEntries: (filesOrDirectories: string[], fileNames?: string[]) => string[];

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

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