@coveo/platform-client 40.9.2 → 40.10.0

package/dist/cjs/resources/Extensions/Extensions.js

@@ -28,6 +28,14 @@ class Extension extends Resource_js_1.default {
     list() {
         return this.api.get(Extension.baseUrl);
     }
+    /**
+     * Validates the extension's script
+     *
+     * @param {ExtensionCompileCode} extensionCode The code to compile
+     */
+    validateCode(extensionCode) {
+        return this.api.post(`${Extension.baseUrl}/test/compile`, extensionCode);
+    }
 }
 exports.default = Extension;
 //# sourceMappingURL=Extensions.js.map

package/dist/cjs/resources/Extensions/Extensions.js.map

@@ -1 +1 @@
-{"version":3,"file":"Extensions.js","sourceRoot":"","sources":["../../../../src/resources/Extensions/Extensions.ts"],"names":[],"mappings":";;;;;AAAA,kEAAmC;AACnC,iEAAsC;AAGtC,MAAqB,SAAU,SAAQ,qBAAQ;IAC3C,MAAM,CAAC,OAAO,GAAG,uBAAuB,oBAAG,CAAC,cAAc,aAAa,CAAC;IAExE,MAAM,CAAC,SAA0B;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAiB,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED,MAAM,CAAC,WAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,MAAM,CAAC,WAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,SAAS,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,CAAC,WAAmB,EAAE,MAAe;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,UAAU,EAAE,EAAC,MAAM,EAAC,CAAC,CAAC;IACxF,CAAC;IAED,GAAG,CAAC,WAAmB;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED,IAAI;QACA,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAmB,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7D,CAAC;;AA7BL,4BA8BC"}
+{"version":3,"file":"Extensions.js","sourceRoot":"","sources":["../../../../src/resources/Extensions/Extensions.ts"],"names":[],"mappings":";;;;;AAAA,kEAAmC;AACnC,iEAAsC;AAGtC,MAAqB,SAAU,SAAQ,qBAAQ;IAC3C,MAAM,CAAC,OAAO,GAAG,uBAAuB,oBAAG,CAAC,cAAc,aAAa,CAAC;IAExE,MAAM,CAAC,SAA0B;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAiB,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED,MAAM,CAAC,WAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,MAAM,CAAC,WAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,SAAS,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,CAAC,WAAmB,EAAE,MAAe;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,UAAU,EAAE,EAAC,MAAM,EAAC,CAAC,CAAC;IACxF,CAAC;IAED,GAAG,CAAC,WAAmB;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED,IAAI;QACA,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAmB,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,aAAmC;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAuB,GAAG,SAAS,CAAC,OAAO,eAAe,EAAE,aAAa,CAAC,CAAC;IACnG,CAAC;;AAtCL,4BAuCC"}

package/dist/esm/resources/Extensions/Extensions.js

@@ -23,5 +23,13 @@ export default class Extension extends Resource {
     list() {
         return this.api.get(Extension.baseUrl);
     }
+    /**
+     * Validates the extension's script
+     *
+     * @param {ExtensionCompileCode} extensionCode The code to compile
+     */
+    validateCode(extensionCode) {
+        return this.api.post(`${Extension.baseUrl}/test/compile`, extensionCode);
+    }
 }
 //# sourceMappingURL=Extensions.js.map

package/dist/esm/resources/Extensions/Extensions.js.map

@@ -1 +1 @@
-{"version":3,"file":"Extensions.js","sourceRoot":"","sources":["../../../../src/resources/Extensions/Extensions.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AACnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAGtC,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,QAAQ;IAC3C,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,aAAa,CAAC;IAExE,MAAM,CAAC,SAA0B;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAiB,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED,MAAM,CAAC,WAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,MAAM,CAAC,WAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,SAAS,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,CAAC,WAAmB,EAAE,MAAe;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,UAAU,EAAE,EAAC,MAAM,EAAC,CAAC,CAAC;IACxF,CAAC;IAED,GAAG,CAAC,WAAmB;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED,IAAI;QACA,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAmB,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7D,CAAC"}
+{"version":3,"file":"Extensions.js","sourceRoot":"","sources":["../../../../src/resources/Extensions/Extensions.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AACnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAGtC,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,QAAQ;IAC3C,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,aAAa,CAAC;IAExE,MAAM,CAAC,SAA0B;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAiB,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,CAAC,WAAmB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED,MAAM,CAAC,WAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,MAAM,CAAC,WAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,SAAS,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,CAAC,WAAmB,EAAE,MAAe;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,UAAU,EAAE,EAAC,MAAM,EAAC,CAAC,CAAC;IACxF,CAAC;IAED,GAAG,CAAC,WAAmB;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,GAAG,SAAS,CAAC,OAAO,IAAI,WAAW,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED,IAAI;QACA,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAmB,SAAS,CAAC,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,aAAmC;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAuB,GAAG,SAAS,CAAC,OAAO,eAAe,EAAE,aAAa,CAAC,CAAC;IACnG,CAAC"}

package/dist/types/resources/Extensions/Extensions.d.ts

@@ -1,5 +1,5 @@
 import Resource from '../Resource.js';
-import { CreateExtension, ExtensionModel } from './ExtensionsInterfaces.js';
+import { CreateExtension, ExtensionCompileCode, ExtensionModel } from './ExtensionsInterfaces.js';
 export default class Extension extends Resource {
     static baseUrl: string;
     create(extension: CreateExtension): Promise<ExtensionModel>;
@@ -9,4 +9,10 @@ export default class Extension extends Resource {
     disable(extensionId: string, reason?: string): Promise<void>;
     get(extensionId: string): Promise<ExtensionModel>;
     list(): Promise<ExtensionModel[]>;
+    /**
+     * Validates the extension's script
+     *
+     * @param {ExtensionCompileCode} extensionCode The code to compile
+     */
+    validateCode(extensionCode: ExtensionCompileCode): Promise<ExtensionCompileCode>;
 }

package/dist/types/resources/Extensions/ExtensionsInterfaces.d.ts

@@ -52,4 +52,39 @@ export interface CreateExtension extends GranularResource {
     language?: ExtensionLanguageType;
     requiredDataStreams?: DataStreamType[];
 }
+export interface ExtensionCompileCode {
+    /**
+     * The extension's code that is compiled.
+     */
+    code: string;
+    /**
+     * The langugage of the compiled code.
+     */
+    language: ExtensionLanguageType;
+}
+export interface ExtensionCompileResult {
+    error: ExtensionCompileError;
+    /**
+     * Whether the extension's script's compilation was successful.
+     */
+    successful: boolean;
+}
+export interface ExtensionCompileError {
+    /**
+     * The line number where the error occurred.
+     */
+    line: number;
+    /**
+     * The compilation error message.
+     */
+    message: string;
+    /**
+     * The specific offset in the line where the error occured.
+     */
+    offset: number;
+    /**
+     * The compilation error type.
+     */
+    type: string;
+}
 export {};

package/dist/types/resources/IPXInterfaces/IPXInterface.model.d.ts

@@ -37,7 +37,86 @@ export interface IPXResultTemplate extends HostedInterfaceResultTemplate {
     details: IPXResultTemplateDetail[];
 }
 export interface IPXButton {
-    label: string;
+    /**
+     * The label appearing on the IPX button.
+     */
+    label?: string;
+    /**
+     * The icon appearing on the IPX button when the IPX is open.
+     */
+    closeIcon?: string;
+    /**
+     * The icon appearing on the IPX button when the IPX is close.
+     */
+    openIcon?: string;
+}
+export interface IPXContainer {
+    /**
+     * Whether the IPX is using a target selector.
+     */
+    usesTargetSelector?: boolean;
+    /**
+     * The IPX button information.
+     */
+    button?: IPXButton;
+    /**
+     * The CSS selector used to target the host component of the IPX when usesTargetSelector is true.
+     */
+    targetSelector?: string;
+}
+export interface IPXColors {
+    /**
+     * Primary color.
+     */
+    primary: string;
+    /**
+     * The background color.
+     */
+    background: string;
+    /**
+     * The neutral color.
+     */
+    neutral: string;
+    /**
+     * The visited link color.
+     */
+    visitedLink: string;
+    /**
+     * The titles color.
+     */
+    titles: string;
+    /**
+     * The button color.
+     */
+    button: string;
+    /**
+     * The button label color.
+     */
+    buttonLabel: string;
+}
+export interface IPXStyle {
+    /**
+     * The colors of the IPX.
+     */
+    colors: IPXColors;
+    /**
+     * The font-family of the IPX.
+     */
+    fontFamily: string;
+}
+export interface IPXFooter {
+    /**
+     * The footer's label.
+     */
+    label?: string;
+    /**
+     * The footer's icon.
+     */
+    icon?: string;
+    /**
+     * The footer's link.
+     */
+    link?: string;
 }
 export interface IPXInterfaceConfiguration extends HostedInterfaceConfiguration {
     /**
@@ -51,12 +130,17 @@ export interface IPXInterfaceConfiguration extends HostedInterfaceConfiguration
     /**
      * The list of result templates defined for the ipx.
      */
+    resultTemplates: IPXResultTemplate[];
     /**
-     * The list of result templates defined for the ipx.
+     * The list of 0 to 3 footers to display.
      */
-    resultTemplates: IPXResultTemplate[];
+    footer: IPXFooter[];
+    /**
+     * The container information.
+     */
+    container: IPXContainer;
     /**
-     * The button element of the ipx interface.
+     * The style configuration.
      */
-    button: IPXButton;
+    style: IPXStyle;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@coveo/platform-client",
-    "version": "40.9.2",
+    "version": "40.10.0",
     "description": "",
     "type": "module",
     "exports": {
@@ -32,29 +32,29 @@
         "prepare": "husky install"
     },
     "devDependencies": {
-        "@commitlint/cli": "17.4.2",
-        "@commitlint/config-conventional": "17.4.2",
-        "@types/jest": "29.2.6",
-        "@typescript-eslint/eslint-plugin": "5.48.2",
-        "@typescript-eslint/parser": "5.48.2",
+        "@commitlint/cli": "17.4.4",
+        "@commitlint/config-conventional": "17.4.4",
+        "@types/jest": "29.4.0",
+        "@typescript-eslint/eslint-plugin": "5.53.0",
+        "@typescript-eslint/parser": "5.53.0",
         "abortcontroller-polyfill": "1.7.5",
         "cz-conventional-changelog": "3.3.0",
-        "eslint": "8.32.0",
+        "eslint": "8.34.0",
         "eslint-config-prettier": "8.6.0",
         "eslint-config-typescript": "3.0.0",
         "eslint-plugin-jest": "27.2.1",
         "eslint-plugin-prettier": "4.2.1",
         "husky": "8.0.3",
-        "jest": "29.3.1",
+        "jest": "29.4.3",
         "jest-fetch-mock": "3.0.3",
         "jest-runner-eslint": "1.1.0",
-        "lint-staged": "13.1.0",
-        "prettier": "2.8.3",
-        "semantic-release": "20.0.3",
+        "lint-staged": "13.1.2",
+        "prettier": "2.8.4",
+        "semantic-release": "20.1.0",
         "ts-jest": "29.0.5",
         "tsjs": "4.2.1",
-        "tslib": "2.4.1",
-        "typescript": "4.9.4"
+        "tslib": "2.5.0",
+        "typescript": "4.9.5"
     },
     "prettier": "tsjs/prettier-config",
     "lint-staged": {