@coveo/platform-client 37.9.0 → 37.10.0

package/README.md

@@ -263,18 +263,4 @@ ExperimentalPlatformClient.something.list();
 
 ## Contributing
 
-### Guidelines
-
--   Make sure your changes are fully tested (when applicable).
--   We tend to avoid comments in our code base, we strongly prefer good naming and code structure.
--   Avoid pushing similar changes in different commits if it's within the same feature, because we want the changelogs to be clear and simple. To avoid that, there are at least 2 options:
-    1. Squash the commits into one when merging (you need to edit the final commit message though)
-    1. amend the previous commit when making related changes (`git commit --amend --no-edit`)
-
-### Commit messages
-
-**Every commit message must comply with the [Angular Commit Message Conventions](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format) specification. We use the commit messages to automatically bump the package version according to the semantic versionning notation. Moreover, we generate changlogs for each version using those commit messages.**
-
--   You can either manually write a commit message that follows the convention using your favorite method.
--   Or you can run `npm run commit-cli`. It will prompt you some questions about the nature of your changes, then it will commit your staged changes along with a generated message that follows our convention.
--   Commits containing breaking changes need to be marked as such in the commit footer. See [BREAKING CHANGE convention](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit-message-footer).
+See [CONTRIBUTING.md](./CONTRIBUTING.md)

package/dist/definitions/resources/Pipelines/Conditions/Condition.d.ts

@@ -3,9 +3,36 @@ import Resource from '../../Resource';
 import { ConditionModel, ListConditionsOptions, NewConditionModel } from './ConditionInterfaces';
 export default class Condition extends Resource {
     static baseUrl: string;
+    /**
+     * Returns a paginated list of condition models.
+     * @param {ListConditionsOptions} options
+     */
     list(options?: ListConditionsOptions): Promise<PageModel<ConditionModel, "statements">>;
+    /**
+     * Creates and returns a new condition model.
+     * @param {NewConditionModel} conditionModel
+     */
     create(conditionModel: NewConditionModel): Promise<ConditionModel>;
+    /**
+     * Delete a condition model.
+     * @param {string} conditionId The unique identifier of the condition to be deleted.
+     */
     delete(conditionId: string): Promise<Record<string, unknown>>;
+    /**
+     * Returns a condition model.
+     * @param {string} conditionId The unique identifier of the condition to be fetched.
+     */
     get(conditionId: string): Promise<ConditionModel>;
+    /**
+     * Update a condition model with the model sent and returns the updated condition model.
+     * @param {string} conditionId The unique identifier of the condition to be updated.
+     * @param {ConditionModel | NewConditionModel} conditionModel
+     */
     update(conditionId: string, conditionModel: ConditionModel | NewConditionModel): Promise<ConditionModel>;
+    /**
+     * Bulk get a list of conditions corresponding of the ids sent.
+     * @param {string[]} conditionIds The list of condition's ids to be fetched. Limit of 1000 incoming ids.
+     * @param {ListConditionsOptions} params
+     */
+    bulkGet(conditionIds: string[], params?: ListConditionsOptions): Promise<PageModel<ConditionModel, "statements">>;
 }

package/dist/definitions/resources/Pipelines/Conditions/ConditionInterfaces.d.ts

@@ -1,25 +1,87 @@
 import { Paginated } from '../../BaseInterfaces';
 import { ListStatementSortBy } from '../../Enums';
 export interface ConditionModel {
+    /**
+     * The unique identifier of this statement.
+     */
     id: string;
+    /**
+     * The intented purpose of thi statement in an actual implementation.
+     */
     description: string;
+    /**
+     * The query pipeline language expression that defines this statement.
+     */
     definition: string;
+    /**
+     * The structured object of the query pipeline language expression of this statement.
+     */
     detailed: any;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
     childrenCount: number;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
     feature: string;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
     position: number;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
     ready: boolean;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
     parent?: string;
+    /**
+     * @deprecated
+     * This property is exposed for backward compatibility reasons.
+     */
     condition?: string;
 }
 export interface NewConditionModel {
+    /**
+     * The query pipeline language expression that defines this statement.
+     */
     definition: string;
+    /**
+     * The unique identifier of this statement.
+     */
     id?: string;
+    /**
+     * The intented purpose of this statement in an actual implementation.
+     */
     description?: string;
 }
 export interface ListConditionsOptions extends Paginated {
-    isOrderDescending?: boolean;
+    /**
+     * Whether to sort the results in ascending order.
+     * @default true
+     */
+    isOrderAscending?: boolean;
+    /**
+     * The query filter to match.
+     * This allows you to search within query pipeline statement definitions and descriptions.
+     * By default, results are not required to match a specific query filter.
+     */
     filter?: string;
+    /**
+     * The sort criteria to apply on the results.
+     * @default ListStatementSortBy.Position
+     */
     sortBy?: ListStatementSortBy;
+    /**
+     * The unique identifier of the target Coveo Cloud organization.
+     * The value set by default is provided by the API resource
+     */
     organizationId?: string;
 }

package/dist/resources/Pipelines/Conditions/Condition.js

@@ -7,22 +7,54 @@ var Condition = /** @class */ (function (_super) {
     function Condition() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Returns a paginated list of condition models.
+     * @param {ListConditionsOptions} options
+     */
     Condition.prototype.list = function (options) {
         if (options === void 0) { options = {}; }
         return this.api.get(this.buildPath(Condition.baseUrl, tslib_1.__assign({ feature: 'when', organizationId: this.api.organizationId }, options)));
     };
+    /**
+     * Creates and returns a new condition model.
+     * @param {NewConditionModel} conditionModel
+     */
     Condition.prototype.create = function (conditionModel) {
         return this.api.post(this.buildPath(Condition.baseUrl, { organizationId: this.api.organizationId }), conditionModel);
     };
+    /**
+     * Delete a condition model.
+     * @param {string} conditionId The unique identifier of the condition to be deleted.
+     */
     Condition.prototype.delete = function (conditionId) {
         return this.api.delete(this.buildPath("".concat(Condition.baseUrl, "/").concat(conditionId), { organizationId: this.api.organizationId }));
     };
+    /**
+     * Returns a condition model.
+     * @param {string} conditionId The unique identifier of the condition to be fetched.
+     */
     Condition.prototype.get = function (conditionId) {
         return this.api.get(this.buildPath("".concat(Condition.baseUrl, "/").concat(conditionId), { organizationId: this.api.organizationId }));
     };
+    /**
+     * Update a condition model with the model sent and returns the updated condition model.
+     * @param {string} conditionId The unique identifier of the condition to be updated.
+     * @param {ConditionModel | NewConditionModel} conditionModel
+     */
     Condition.prototype.update = function (conditionId, conditionModel) {
         return this.api.put(this.buildPath("".concat(Condition.baseUrl, "/").concat(conditionId), { organizationId: this.api.organizationId }), conditionModel);
     };
+    /**
+     * Bulk get a list of conditions corresponding of the ids sent.
+     * @param {string[]} conditionIds The list of condition's ids to be fetched. Limit of 1000 incoming ids.
+     * @param {ListConditionsOptions} params
+     */
+    Condition.prototype.bulkGet = function (conditionIds, params) {
+        if (params === void 0) { params = {}; }
+        return this.api.post(this.buildPath("".concat(Condition.baseUrl, "/bulkGet"), tslib_1.__assign({ organizationId: this.api.organizationId }, params)), {
+            ids: conditionIds,
+        });
+    };
     Condition.baseUrl = "/rest/search/v1/admin/pipelines/statements";
     return Condition;
 }(Resource_1.default));

package/dist/resources/Pipelines/Conditions/Condition.js.map

@@ -1 +1 @@
-{"version":3,"file":"Condition.js","sourceRoot":"","sources":["../../../../src/resources/Pipelines/Conditions/Condition.ts"],"names":[],"mappings":";;;AACA,oEAAsC;AAGtC;IAAuC,qCAAQ;IAA/C;;IAkCA,CAAC;IA/BG,wBAAI,GAAJ,UAAK,OAAmC;QAAnC,wBAAA,EAAA,YAAmC;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,qBAAG,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,IAAK,OAAO,EAAE,CAC5G,CAAC;IACN,CAAC;IAED,0BAAM,GAAN,UAAO,cAAiC;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAC,CAAC,EAC5E,cAAc,CACjB,CAAC;IACN,CAAC;IAED,0BAAM,GAAN,UAAO,WAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAClB,IAAI,CAAC,SAAS,CAAC,UAAG,SAAS,CAAC,OAAO,cAAI,WAAW,CAAE,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAC,CAAC,CACnG,CAAC;IACN,CAAC;IAED,uBAAG,GAAH,UAAI,WAAmB;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,UAAG,SAAS,CAAC,OAAO,cAAI,WAAW,CAAE,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAC,CAAC,CACnG,CAAC;IACN,CAAC;IAED,0BAAM,GAAN,UAAO,WAAmB,EAAE,cAAkD;QAC1E,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,UAAG,SAAS,CAAC,OAAO,cAAI,WAAW,CAAE,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAC,CAAC,EAChG,cAAc,CACjB,CAAC;IACN,CAAC;IAhCM,iBAAO,GAAG,4CAA4C,CAAC;IAiClE,gBAAC;CAAA,AAlCD,CAAuC,kBAAQ,GAkC9C;kBAlCoB,SAAS"}
+{"version":3,"file":"Condition.js","sourceRoot":"","sources":["../../../../src/resources/Pipelines/Conditions/Condition.ts"],"names":[],"mappings":";;;AACA,oEAAsC;AAGtC;IAAuC,qCAAQ;IAA/C;;IAyEA,CAAC;IAtEG;;;OAGG;IACH,wBAAI,GAAJ,UAAK,OAAmC;QAAnC,wBAAA,EAAA,YAAmC;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,qBAAG,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,IAAK,OAAO,EAAE,CAC5G,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,0BAAM,GAAN,UAAO,cAAiC;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAC,CAAC,EAC5E,cAAc,CACjB,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,0BAAM,GAAN,UAAO,WAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAClB,IAAI,CAAC,SAAS,CAAC,UAAG,SAAS,CAAC,OAAO,cAAI,WAAW,CAAE,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAC,CAAC,CACnG,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,uBAAG,GAAH,UAAI,WAAmB;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,UAAG,SAAS,CAAC,OAAO,cAAI,WAAW,CAAE,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAC,CAAC,CACnG,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,0BAAM,GAAN,UAAO,WAAmB,EAAE,cAAkD;QAC1E,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,UAAG,SAAS,CAAC,OAAO,cAAI,WAAW,CAAE,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAC,CAAC,EAChG,cAAc,CACjB,CAAC;IACN,CAAC;IAED;;;;OAIG;IAEH,2BAAO,GAAP,UAAQ,YAAsB,EAAE,MAAkC;QAAlC,uBAAA,EAAA,WAAkC;QAC9D,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,SAAS,CAAC,UAAG,SAAS,CAAC,OAAO,aAAU,qBACzC,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,IACpC,MAAM,EACX,EACF;YACI,GAAG,EAAE,YAAY;SACpB,CACJ,CAAC;IACN,CAAC;IAvEM,iBAAO,GAAG,4CAA4C,CAAC;IAwElE,gBAAC;CAAA,AAzED,CAAuC,kBAAQ,GAyE9C;kBAzEoB,SAAS"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@coveo/platform-client",
-    "version": "37.9.0",
+    "version": "37.10.0",
     "description": "",
     "main": "dist/Entry.js",
     "types": "dist/definitions/Entry.d.ts",
@@ -34,14 +34,14 @@
         "eslint": "8.28.0",
         "eslint-config-prettier": "8.5.0",
         "eslint-config-typescript": "3.0.0",
-        "eslint-plugin-jest": "27.1.5",
+        "eslint-plugin-jest": "27.1.6",
         "eslint-plugin-prettier": "4.2.1",
         "husky": "8.0.2",
         "jest": "29.3.1",
         "jest-fetch-mock": "3.0.3",
         "jest-runner-eslint": "1.1.0",
-        "lint-staged": "13.0.3",
-        "prettier": "2.7.1",
+        "lint-staged": "13.0.4",
+        "prettier": "2.8.0",
         "semantic-release": "19.0.5",
         "ts-jest": "29.0.3",
         "tsjs": "4.2.1",
@@ -80,5 +80,6 @@
     },
     "publishConfig": {
         "access": "public"
-    }
+    },
+    "packageManager": "npm@latest"
 }