@coveo/push-api-client 3.0.122 → 3.0.124

package/dist/documentBuilder.js

@@ -1,293 +1,293 @@
-"use strict";
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocumentBuilder = void 0;
-const dayjs = require("dayjs");
-const crypto_1 = require("crypto");
-const fieldUtils_1 = require("./fieldAnalyser/fieldUtils");
-const fieldErrors_1 = require("./errors/fieldErrors");
-const transformer_1 = require("./validation/transformers/transformer");
-const zod_1 = require("zod");
-const url_1 = require("url");
-/**
- * Utility class to build a {@link Document}.
- */
-class DocumentBuilder {
-    /**
-     *
-     * @param uri The URI of the document. See {@link Document.uri}
-     * @param title The title of the document. See {@link Document.title}
-     */
-    constructor(uri, title) {
-        this.uri = uri;
-        this.permissions = [];
-        this.doc = {
-            uri,
-            title,
-            metadata: {},
-            permissions: this.permissions,
-        };
-    }
-    /**
-     * Set the data of the document. See {@link Document.data}
-     * @param data
-     * @returns
-     */
-    withData(data) {
-        this.doc.data = data;
-        return this;
-    }
-    /**
-     * Set the date of the document. See {@link Document.date}
-     * @param date
-     * @returns
-     */
-    withDate(date) {
-        this.doc.date = this.validateDateAndReturnValidDate(date);
-        return this;
-    }
-    /**
-     * Set the modified date of the document. See {@link Document.modifiedDate}
-     * @param date
-     * @returns
-     */
-    withModifiedDate(date) {
-        this.doc.modifiedDate = this.validateDateAndReturnValidDate(date);
-        return this;
-    }
-    /**
-     * Set the permanentID of the document. See {@link Document.permanentId}
-     * @param permanentID
-     * @returns
-     */
-    withPermanentId(permanentID) {
-        this.doc.permanentId = permanentID;
-        return this;
-    }
-    /**
-     * Set the base64 encoded, compressed binary data of the document. See {@link Document.compressedBinaryData}
-     * @param data
-     * @param compressionType
-     * @returns
-     */
-    withCompressedBinaryData(data, compressionType) {
-        this.validateCompressedBinaryData(data);
-        this.doc.compressedBinaryData = {
-            data,
-            compressionType,
-        };
-        return this;
-    }
-    /**
-     * Set the file extension on the document. See {@link Document.fileExtension}
-     * @param extension
-     * @returns
-     */
-    withFileExtension(extension) {
-        if (extension[0] !== '.') {
-            throw `Extension ${extension} should start with a leading .`;
-        }
-        this.doc.fileExtension = extension;
-        return this;
-    }
-    /**
-     * Set the parentID on the document. See {@link Document.parentId}
-     * @param id
-     * @returns
-     */
-    withParentID(id) {
-        this.doc.parentId = id;
-        return this;
-    }
-    /**
-     * Set the clickableURI on the document. See {@link Document.clickableUri}
-     * @param clickURI
-     * @returns
-     */
-    withClickableUri(clickURI) {
-        // TODO: Validate that it's a valid link/proper scheme... ?
-        // Unsure
-        this.doc.clickableUri = clickURI;
-        return this;
-    }
-    /**
-     * Set the author on the document. See {@link Document.author}
-     * @param author
-     * @returns
-     */
-    withAuthor(author) {
-        this.doc.author = author;
-        return 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, value, keyTransformer = transformer_1.BuiltInTransformers.identity) {
-        const transformedKey = keyTransformer(key);
-        const reservedKeyNames = [
-            'compressedBinaryData',
-            'compressedBinaryDataFileId',
-            'parentId',
-            'fileExtension',
-            'data',
-            'permissions',
-            'documentId',
-            'orderingId',
-        ];
-        if (reservedKeyNames.some((reservedKey) => reservedKey.toLowerCase() === transformedKey.toLowerCase())) {
-            throw `Cannot use ${transformedKey} as a metadata key: It is a reserved key name. See https://docs.coveo.com/en/78/index-content/push-api-reference#json-document-reserved-key-names`;
-        }
-        if (!(0, fieldUtils_1.isFieldNameValid)(transformedKey)) {
-            throw new fieldErrors_1.UnsupportedFieldError([key, transformedKey]);
-        }
-        this.doc.metadata[transformedKey] = value;
-        return 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, metadataKeyTransformer = transformer_1.BuiltInTransformers.identity) {
-        const invalidKeys = [];
-        for (const [k, v] of Object.entries(metadata)) {
-            try {
-                this.withMetadataValue(k, v, metadataKeyTransformer);
-            }
-            catch (error) {
-                if (error instanceof fieldErrors_1.UnsupportedFieldError) {
-                    invalidKeys.push(...error.unsupportedFields);
-                }
-                else {
-                    throw error;
-                }
-            }
-        }
-        if (invalidKeys.length > 0) {
-            throw new fieldErrors_1.UnsupportedFieldError(...invalidKeys);
-        }
-        return 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) {
-        this.permissions.push(permissionSetBuilder.build());
-        return 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, permissionSetBuilders) {
-        const permissionSets = permissionSetBuilders.map((permissionSet) => permissionSet.build());
-        this.permissions.push({
-            name: permissionLevelName,
-            permissionSets,
-        });
-        return this;
-    }
-    build() {
-        return this.doc;
-    }
-    /**
-     * Marshal the document into a JSON format accepted by the push API.
-     * @returns
-     */
-    marshal() {
-        this.validateAndFillMissing();
-        const _a = this.doc, { uri, metadata, permissions, permanentId } = _a, omitSomeProperties = __rest(_a, ["uri", "metadata", "permissions", "permanentId"]);
-        const out = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ permanentid: permanentId }, omitSomeProperties), this.marshalMetadata()), this.marshalCompressedBinaryData()), this.marshalPermissions()), this.marshalDocumentId());
-        return out;
-    }
-    marshalDocumentId() {
-        return {
-            documentId: zod_1.z.string().url().safeParse(this.uri).success
-                ? this.uri
-                : (0, url_1.pathToFileURL)(this.uri).toString(),
-        };
-    }
-    marshalMetadata() {
-        if (!this.doc.metadata) {
-            return {};
-        }
-        const out = {};
-        for (const [k, v] of Object.entries(this.doc.metadata)) {
-            out[k] = v;
-        }
-        return out;
-    }
-    marshalCompressedBinaryData() {
-        if (!this.doc.compressedBinaryData) {
-            return {};
-        }
-        return {
-            compressedBinaryData: this.doc.compressedBinaryData.data,
-            compressionType: this.doc.compressedBinaryData.compressionType,
-        };
-    }
-    marshalPermissions() {
-        const permissions = this.permissions;
-        return Object.assign({}, (permissions.length && { permissions }));
-    }
-    validateAndFillMissing() {
-        // TODO: validation that cannot be performed on a single property, but requires looking at multiple property at the same time.
-        // or validate that we don't have both `data` AND `compressedBinaryData`.
-        // Could also use https://www.npmjs.com/package/@coveo/bueno to validate schema (useful for pure JS users).
-        if (!this.doc.permanentId) {
-            this.doc.permanentId = this.generatePermanentId();
-        }
-        return;
-    }
-    generatePermanentId() {
-        const md5 = (0, crypto_1.createHash)('md5').update(this.doc.uri).digest('hex');
-        const sha1 = (0, crypto_1.createHash)('sha1').update(this.doc.uri).digest('hex');
-        return md5.substring(0, 30) + sha1.substring(0, 30);
-    }
-    validateDateAndReturnValidDate(d) {
-        const validatedDate = dayjs(d);
-        return validatedDate.toISOString();
-    }
-    validateCompressedBinaryData(data) {
-        const isBase64 = Buffer.from(data, 'base64').toString('base64') === data;
-        if (!isBase64) {
-            throw 'Invalid compressedBinaryData: When using compressedBinaryData, the data must be base64 encoded.';
-        }
-    }
-}
-exports.DocumentBuilder = DocumentBuilder;
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentBuilder = void 0;
+const dayjs = require("dayjs");
+const crypto_1 = require("crypto");
+const fieldUtils_1 = require("./fieldAnalyser/fieldUtils");
+const fieldErrors_1 = require("./errors/fieldErrors");
+const transformer_1 = require("./validation/transformers/transformer");
+const zod_1 = require("zod");
+const url_1 = require("url");
+/**
+ * Utility class to build a {@link Document}.
+ */
+class DocumentBuilder {
+    /**
+     *
+     * @param uri The URI of the document. See {@link Document.uri}
+     * @param title The title of the document. See {@link Document.title}
+     */
+    constructor(uri, title) {
+        this.uri = uri;
+        this.permissions = [];
+        this.doc = {
+            uri,
+            title,
+            metadata: {},
+            permissions: this.permissions,
+        };
+    }
+    /**
+     * Set the data of the document. See {@link Document.data}
+     * @param data
+     * @returns
+     */
+    withData(data) {
+        this.doc.data = data;
+        return this;
+    }
+    /**
+     * Set the date of the document. See {@link Document.date}
+     * @param date
+     * @returns
+     */
+    withDate(date) {
+        this.doc.date = this.validateDateAndReturnValidDate(date);
+        return this;
+    }
+    /**
+     * Set the modified date of the document. See {@link Document.modifiedDate}
+     * @param date
+     * @returns
+     */
+    withModifiedDate(date) {
+        this.doc.modifiedDate = this.validateDateAndReturnValidDate(date);
+        return this;
+    }
+    /**
+     * Set the permanentID of the document. See {@link Document.permanentId}
+     * @param permanentID
+     * @returns
+     */
+    withPermanentId(permanentID) {
+        this.doc.permanentId = permanentID;
+        return this;
+    }
+    /**
+     * Set the base64 encoded, compressed binary data of the document. See {@link Document.compressedBinaryData}
+     * @param data
+     * @param compressionType
+     * @returns
+     */
+    withCompressedBinaryData(data, compressionType) {
+        this.validateCompressedBinaryData(data);
+        this.doc.compressedBinaryData = {
+            data,
+            compressionType,
+        };
+        return this;
+    }
+    /**
+     * Set the file extension on the document. See {@link Document.fileExtension}
+     * @param extension
+     * @returns
+     */
+    withFileExtension(extension) {
+        if (extension[0] !== '.') {
+            throw `Extension ${extension} should start with a leading .`;
+        }
+        this.doc.fileExtension = extension;
+        return this;
+    }
+    /**
+     * Set the parentID on the document. See {@link Document.parentId}
+     * @param id
+     * @returns
+     */
+    withParentID(id) {
+        this.doc.parentId = id;
+        return this;
+    }
+    /**
+     * Set the clickableURI on the document. See {@link Document.clickableUri}
+     * @param clickURI
+     * @returns
+     */
+    withClickableUri(clickURI) {
+        // TODO: Validate that it's a valid link/proper scheme... ?
+        // Unsure
+        this.doc.clickableUri = clickURI;
+        return this;
+    }
+    /**
+     * Set the author on the document. See {@link Document.author}
+     * @param author
+     * @returns
+     */
+    withAuthor(author) {
+        this.doc.author = author;
+        return 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, value, keyTransformer = transformer_1.BuiltInTransformers.identity) {
+        const transformedKey = keyTransformer(key);
+        const reservedKeyNames = [
+            'compressedBinaryData',
+            'compressedBinaryDataFileId',
+            'parentId',
+            'fileExtension',
+            'data',
+            'permissions',
+            'documentId',
+            'orderingId',
+        ];
+        if (reservedKeyNames.some((reservedKey) => reservedKey.toLowerCase() === transformedKey.toLowerCase())) {
+            throw `Cannot use ${transformedKey} as a metadata key: It is a reserved key name. See https://docs.coveo.com/en/78/index-content/push-api-reference#json-document-reserved-key-names`;
+        }
+        if (!(0, fieldUtils_1.isFieldNameValid)(transformedKey)) {
+            throw new fieldErrors_1.UnsupportedFieldError([key, transformedKey]);
+        }
+        this.doc.metadata[transformedKey] = value;
+        return 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, metadataKeyTransformer = transformer_1.BuiltInTransformers.identity) {
+        const invalidKeys = [];
+        for (const [k, v] of Object.entries(metadata)) {
+            try {
+                this.withMetadataValue(k, v, metadataKeyTransformer);
+            }
+            catch (error) {
+                if (error instanceof fieldErrors_1.UnsupportedFieldError) {
+                    invalidKeys.push(...error.unsupportedFields);
+                }
+                else {
+                    throw error;
+                }
+            }
+        }
+        if (invalidKeys.length > 0) {
+            throw new fieldErrors_1.UnsupportedFieldError(...invalidKeys);
+        }
+        return 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) {
+        this.permissions.push(permissionSetBuilder.build());
+        return 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, permissionSetBuilders) {
+        const permissionSets = permissionSetBuilders.map((permissionSet) => permissionSet.build());
+        this.permissions.push({
+            name: permissionLevelName,
+            permissionSets,
+        });
+        return this;
+    }
+    build() {
+        return this.doc;
+    }
+    /**
+     * Marshal the document into a JSON format accepted by the push API.
+     * @returns
+     */
+    marshal() {
+        this.validateAndFillMissing();
+        const _a = this.doc, { uri, metadata, permissions, permanentId } = _a, omitSomeProperties = __rest(_a, ["uri", "metadata", "permissions", "permanentId"]);
+        const out = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ permanentid: permanentId }, omitSomeProperties), this.marshalMetadata()), this.marshalCompressedBinaryData()), this.marshalPermissions()), this.marshalDocumentId());
+        return out;
+    }
+    marshalDocumentId() {
+        return {
+            documentId: zod_1.z.string().url().safeParse(this.uri).success
+                ? this.uri
+                : (0, url_1.pathToFileURL)(this.uri).toString(),
+        };
+    }
+    marshalMetadata() {
+        if (!this.doc.metadata) {
+            return {};
+        }
+        const out = {};
+        for (const [k, v] of Object.entries(this.doc.metadata)) {
+            out[k] = v;
+        }
+        return out;
+    }
+    marshalCompressedBinaryData() {
+        if (!this.doc.compressedBinaryData) {
+            return {};
+        }
+        return {
+            compressedBinaryData: this.doc.compressedBinaryData.data,
+            compressionType: this.doc.compressedBinaryData.compressionType,
+        };
+    }
+    marshalPermissions() {
+        const permissions = this.permissions;
+        return Object.assign({}, (permissions.length && { permissions }));
+    }
+    validateAndFillMissing() {
+        // TODO: validation that cannot be performed on a single property, but requires looking at multiple property at the same time.
+        // or validate that we don't have both `data` AND `compressedBinaryData`.
+        // Could also use https://www.npmjs.com/package/@coveo/bueno to validate schema (useful for pure JS users).
+        if (!this.doc.permanentId) {
+            this.doc.permanentId = this.generatePermanentId();
+        }
+        return;
+    }
+    generatePermanentId() {
+        const md5 = (0, crypto_1.createHash)('md5').update(this.doc.uri).digest('hex');
+        const sha1 = (0, crypto_1.createHash)('sha1').update(this.doc.uri).digest('hex');
+        return md5.substring(0, 30) + sha1.substring(0, 30);
+    }
+    validateDateAndReturnValidDate(d) {
+        const validatedDate = dayjs(d);
+        return validatedDate.toISOString();
+    }
+    validateCompressedBinaryData(data) {
+        const isBase64 = Buffer.from(data, 'base64').toString('base64') === data;
+        if (!isBase64) {
+            throw 'Invalid compressedBinaryData: When using compressedBinaryData, the data must be base64 encoded.';
+        }
+    }
+}
+exports.DocumentBuilder = DocumentBuilder;
 //# sourceMappingURL=documentBuilder.js.map