@coveo/push-api-client 3.0.117 → 3.0.122

package/dist/APICore.js

@@ -1,48 +1,48 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.APICore = void 0;
-const exponential_backoff_1 = require("exponential-backoff");
-class APICore {
-    constructor(accessToken) {
-        this.accessToken = accessToken;
-    }
-    async request(url, config) {
-        const req = async () => {
-            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.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',
-        });
-    }
-    selectRequester(parse) {
-        return parse ? this.requestJson : this.request;
-    }
-    async delete(url, parse = true) {
-        return this.selectRequester(parse)(url, { method: 'delete' });
-    }
-    get requestHeaders() {
-        const authorizationHeader = {
-            Authorization: `Bearer ${this.accessToken}`,
-        };
-        const documentsRequestHeaders = Object.assign(Object.assign({}, authorizationHeader), { 'Content-Type': 'application/json', Accept: 'application/json' });
-        return documentsRequestHeaders;
-    }
-    isThrottled(status) {
-        return status === 429;
-    }
-}
-exports.APICore = APICore;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APICore = void 0;
+const exponential_backoff_1 = require("exponential-backoff");
+class APICore {
+    constructor(accessToken) {
+        this.accessToken = accessToken;
+    }
+    async request(url, config) {
+        const req = async () => {
+            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.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',
+        });
+    }
+    selectRequester(parse) {
+        return (parse ? this.requestJson : this.request).bind(this);
+    }
+    async delete(url, parse = true) {
+        return this.selectRequester(parse)(url, { method: 'delete' });
+    }
+    get requestHeaders() {
+        const authorizationHeader = {
+            Authorization: `Bearer ${this.accessToken}`,
+        };
+        const documentsRequestHeaders = Object.assign(Object.assign({}, authorizationHeader), { 'Content-Type': 'application/json', Accept: 'application/json' });
+        return documentsRequestHeaders;
+    }
+    isThrottled(status) {
+        return status === 429;
+    }
+}
+exports.APICore = APICore;
 //# sourceMappingURL=APICore.js.map

package/dist/APICore.js.map

@@ -1 +1 @@
-{"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"}
+{"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,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,WAAc,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjE,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,18 +1,18 @@
-import type { Response } from 'undici';
-export declare class APICore {
-    private accessToken;
-    constructor(accessToken: string);
-    private request;
-    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;
-}
+import type { Response } from 'undici';
+export declare class APICore {
+    private accessToken;
+    constructor(accessToken: string);
+    private request;
+    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,124 +1,124 @@
-import { PermissionLevel, PermissionSet } from '@coveo/platform-client';
-type BaseMetadataValue = string | string[] | number | number[] | boolean;
-type DictionaryMetadataValue = Record<string, BaseMetadataValue>;
-export type MetadataValue = BaseMetadataValue | DictionaryMetadataValue;
-export type Metadata = Record<string, MetadataValue>;
-/**
- * The compression type that was applied to your compressed document.
- */
-export type CompressionType = 'UNCOMPRESSED' | 'DEFLATE' | 'GZIP' | 'LZMA' | 'ZLIB';
-/**
- * A Coveo document.
- */
-export interface Document {
-    /**
-     * The Uniform Resource Identifier (URI) that uniquely identifies the document in a Coveo index.
-     *
-     * Examples:
-     * - `http://www.example.com/`
-     * - `file://folder/text.txt`
-     */
-    uri: string;
-    /**
-     * The title of the document.
-     */
-    title: string;
-    /**
-     * The clickable URI associated with the document.
-     */
-    clickableUri?: string;
-    /**
-     * The author of the document.
-     */
-    author?: string;
-    /**
-     * The date of the document, represented as an ISO string.
-     *
-     * Optional, will default to indexation date.
-     */
-    date?: string;
-    /**
-     * The modified date of the document, represented as an ISO string.
-     *
-     * Optional, will default to indexation date.
-     */
-    modifiedDate?: string;
-    /**
-     * The permanent identifier of a document that does not change over time.
-     *
-     * Optional, will be derived from the document URI.
-     */
-    permanentId?: string;
-    /**
-     * The unique identifier (URI) of the parent item.
-     *
-     * Specifying a value for this key creates a relationship between the attachment item (child) and its parent item.
-     *
-     * This value also ensures that a parent and all of its attachments will be routed in the same index slice.
-     */
-    parentId?: string;
-    /**
-     * The textual (non-binary) content of the item.
-     *
-     * Whenever you're pushing a compressed binary item (such as XML/HTML, PDF, Word, or binary), you should use the CompressedBinaryData or CompressedBinaryDataFileId attribute instead, depending on the content size.
-     *
-     * Accepts 5 MB or less of uncompressed textual data.
-     *
-     * See https://docs.coveo.com/en/73 for more information.
-     *
-     * Example: `This is a simple string that will be used for searchability as well as to generate excerpt and summaries for the document.`
-     */
-    data?: string;
-    /**
-     * The original binary item content, compressed using one of the supported compression types (Deflate, GZip, LZMA, Uncompressed, or ZLib), and then Base64 encoded.
-     *
-     * You can use this parameter when you're pushing a compressed binary item (such as XML/HTML, PDF, Word, or binary) whose size is less than 5 MB.
-     *
-     * Whenever you're pushing an item whose size is 5 MB or more, use the CompressedBinaryDataFileIdproperty instead.
-     *
-     * If you're pushing less than 5 MB of textual (non-binary) content, you can use the data property instead.
-     *
-     * See https://docs.coveo.com/en/73 for more information.
-     */
-    compressedBinaryData?: {
-        /**
-         * The compression type that was applied to your document.
-         */
-        compressionType: CompressionType;
-        /**
-         * The base64 encoded binary data.
-         *
-         * Example: `eJxzrUjMLchJBQAK4ALN`
-         */
-        data: string;
-    };
-    /**
-     * The metadata key-value pairs for a given document.
-     *
-     * Each metadata in the document must be unique.
-     *
-     * Metadata are case-insensitive (e.g., the Push API considers mykey, MyKey, myKey, MYKEY, etc. as identical).
-     *
-     * See https://docs.coveo.com/en/115 for more information.
-     */
-    metadata?: Metadata;
-    /**
-     * The list of permission sets for this item.
-     *
-     * This is useful when item based security is required (i.e., when security isn't configured at the source level).
-     *
-     * See https://docs.coveo.com/en/107 for more information.
-     */
-    permissions?: Array<PermissionSet | PermissionLevel>;
-    /**
-     * The file extension of the data you're pushing.
-     *
-     * This is useful when pushing a compressed item. The converter uses this information to identify how to correctly process the item.
-     *
-     * Values must include the preceding . character.
-     *
-     * Example: `.html`
-     */
-    fileExtension?: string;
-}
-export {};
+import { PermissionLevel, PermissionSet } from '@coveo/platform-client';
+type BaseMetadataValue = string | string[] | number | number[] | boolean;
+type DictionaryMetadataValue = Record<string, BaseMetadataValue>;
+export type MetadataValue = BaseMetadataValue | DictionaryMetadataValue;
+export type Metadata = Record<string, MetadataValue>;
+/**
+ * The compression type that was applied to your compressed document.
+ */
+export type CompressionType = 'UNCOMPRESSED' | 'DEFLATE' | 'GZIP' | 'LZMA' | 'ZLIB';
+/**
+ * A Coveo document.
+ */
+export interface Document {
+    /**
+     * The Uniform Resource Identifier (URI) that uniquely identifies the document in a Coveo index.
+     *
+     * Examples:
+     * - `http://www.example.com/`
+     * - `file://folder/text.txt`
+     */
+    uri: string;
+    /**
+     * The title of the document.
+     */
+    title: string;
+    /**
+     * The clickable URI associated with the document.
+     */
+    clickableUri?: string;
+    /**
+     * The author of the document.
+     */
+    author?: string;
+    /**
+     * The date of the document, represented as an ISO string.
+     *
+     * Optional, will default to indexation date.
+     */
+    date?: string;
+    /**
+     * The modified date of the document, represented as an ISO string.
+     *
+     * Optional, will default to indexation date.
+     */
+    modifiedDate?: string;
+    /**
+     * The permanent identifier of a document that does not change over time.
+     *
+     * Optional, will be derived from the document URI.
+     */
+    permanentId?: string;
+    /**
+     * The unique identifier (URI) of the parent item.
+     *
+     * Specifying a value for this key creates a relationship between the attachment item (child) and its parent item.
+     *
+     * This value also ensures that a parent and all of its attachments will be routed in the same index slice.
+     */
+    parentId?: string;
+    /**
+     * The textual (non-binary) content of the item.
+     *
+     * Whenever you're pushing a compressed binary item (such as XML/HTML, PDF, Word, or binary), you should use the CompressedBinaryData or CompressedBinaryDataFileId attribute instead, depending on the content size.
+     *
+     * Accepts 5 MB or less of uncompressed textual data.
+     *
+     * See https://docs.coveo.com/en/73 for more information.
+     *
+     * Example: `This is a simple string that will be used for searchability as well as to generate excerpt and summaries for the document.`
+     */
+    data?: string;
+    /**
+     * The original binary item content, compressed using one of the supported compression types (Deflate, GZip, LZMA, Uncompressed, or ZLib), and then Base64 encoded.
+     *
+     * You can use this parameter when you're pushing a compressed binary item (such as XML/HTML, PDF, Word, or binary) whose size is less than 5 MB.
+     *
+     * Whenever you're pushing an item whose size is 5 MB or more, use the CompressedBinaryDataFileIdproperty instead.
+     *
+     * If you're pushing less than 5 MB of textual (non-binary) content, you can use the data property instead.
+     *
+     * See https://docs.coveo.com/en/73 for more information.
+     */
+    compressedBinaryData?: {
+        /**
+         * The compression type that was applied to your document.
+         */
+        compressionType: CompressionType;
+        /**
+         * The base64 encoded binary data.
+         *
+         * Example: `eJxzrUjMLchJBQAK4ALN`
+         */
+        data: string;
+    };
+    /**
+     * The metadata key-value pairs for a given document.
+     *
+     * Each metadata in the document must be unique.
+     *
+     * Metadata are case-insensitive (e.g., the Push API considers mykey, MyKey, myKey, MYKEY, etc. as identical).
+     *
+     * See https://docs.coveo.com/en/115 for more information.
+     */
+    metadata?: Metadata;
+    /**
+     * The list of permission sets for this item.
+     *
+     * This is useful when item based security is required (i.e., when security isn't configured at the source level).
+     *
+     * See https://docs.coveo.com/en/107 for more information.
+     */
+    permissions?: Array<PermissionSet | PermissionLevel>;
+    /**
+     * The file extension of the data you're pushing.
+     *
+     * This is useful when pushing a compressed item. The converter uses this information to identify how to correctly process the item.
+     *
+     * Values must include the preceding . character.
+     *
+     * Example: `.html`
+     */
+    fileExtension?: string;
+}
+export {};