@coveo/platform-client 40.9.3 → 40.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/dist/cjs/resources/Extensions/Extensions.js +8 -0
  2. package/dist/cjs/resources/Extensions/Extensions.js.map +1 -1
  3. package/dist/esm/resources/Extensions/Extensions.js +8 -0
  4. package/dist/esm/resources/Extensions/Extensions.js.map +1 -1
  5. package/dist/types/resources/Extensions/Extensions.d.ts +7 -1
  6. package/dist/types/resources/Extensions/ExtensionsInterfaces.d.ts +35 -0
  7. package/dist/types/resources/MachineLearning/ModelInformation/ModelInformationInterfaces.d.ts +51 -0
  8. package/package.json +13 -13
package/dist/cjs/resources/Extensions/Extensions.js CHANGED
@@ -28,6 +28,14 @@ class Extension extends Resource_js_1.default {
28
28
  list() {
29
29
  return this.api.get(Extension.baseUrl);
30
30
  }
31
+ /**
32
+ * Validates the extension's script
33
+ *
34
+ * @param {ExtensionCompileCode} extensionCode The code to compile
35
+ */
36
+ validateCode(extensionCode) {
37
+ return this.api.post(`${Extension.baseUrl}/test/compile`, extensionCode);
38
+ }
31
39
  }
32
40
  exports.default = Extension;
33
41
  //# sourceMappingURL=Extensions.js.map
package/dist/cjs/resources/Extensions/Extensions.js.map CHANGED
@@ -1 +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"}
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;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 CHANGED
@@ -23,5 +23,13 @@ export default class Extension extends Resource {
23
23
  list() {
24
24
  return this.api.get(Extension.baseUrl);
25
25
  }
26
+ /**
27
+ * Validates the extension's script
28
+ *
29
+ * @param {ExtensionCompileCode} extensionCode The code to compile
30
+ */
31
+ validateCode(extensionCode) {
32
+ return this.api.post(`${Extension.baseUrl}/test/compile`, extensionCode);
33
+ }
26
34
  }
27
35
  //# sourceMappingURL=Extensions.js.map
package/dist/esm/resources/Extensions/Extensions.js.map CHANGED
@@ -1 +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"}
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;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 CHANGED
@@ -1,5 +1,5 @@
1
1
  import Resource from '../Resource.js';
2
- import { CreateExtension, ExtensionModel } from './ExtensionsInterfaces.js';
2
+ import { CreateExtension, ExtensionCompileCode, ExtensionModel } from './ExtensionsInterfaces.js';
3
3
  export default class Extension extends Resource {
4
4
  static baseUrl: string;
5
5
  create(extension: CreateExtension): Promise<ExtensionModel>;
@@ -9,4 +9,10 @@ export default class Extension extends Resource {
9
9
  disable(extensionId: string, reason?: string): Promise<void>;
10
10
  get(extensionId: string): Promise<ExtensionModel>;
11
11
  list(): Promise<ExtensionModel[]>;
12
+ /**
13
+ * Validates the extension's script
14
+ *
15
+ * @param {ExtensionCompileCode} extensionCode The code to compile
16
+ */
17
+ validateCode(extensionCode: ExtensionCompileCode): Promise<ExtensionCompileCode>;
12
18
  }
package/dist/types/resources/Extensions/ExtensionsInterfaces.d.ts CHANGED
@@ -52,4 +52,39 @@ export interface CreateExtension extends GranularResource {
52
52
  language?: ExtensionLanguageType;
53
53
  requiredDataStreams?: DataStreamType[];
54
54
  }
55
+ export interface ExtensionCompileCode {
56
+ /**
57
+ * The extension's code that is compiled.
58
+ */
59
+ code: string;
60
+ /**
61
+ * The langugage of the compiled code.
62
+ */
63
+ language: ExtensionLanguageType;
64
+ }
65
+ export interface ExtensionCompileResult {
66
+ error: ExtensionCompileError;
67
+ /**
68
+ * Whether the extension's script's compilation was successful.
69
+ */
70
+ successful: boolean;
71
+ }
72
+ export interface ExtensionCompileError {
73
+ /**
74
+ * The line number where the error occurred.
75
+ */
76
+ line: number;
77
+ /**
78
+ * The compilation error message.
79
+ */
80
+ message: string;
81
+ /**
82
+ * The specific offset in the line where the error occured.
83
+ */
84
+ offset: number;
85
+ /**
86
+ * The compilation error type.
87
+ */
88
+ type: string;
89
+ }
55
90
  export {};
package/dist/types/resources/MachineLearning/ModelInformation/ModelInformationInterfaces.d.ts CHANGED
@@ -194,9 +194,60 @@ export interface BuildingStatsSS {
194
194
  headerCount: number;
195
195
  meanSnippetLength: number;
196
196
  }
197
+ /**
198
+ * Snippet details per document
199
+ */
200
+ export interface SnippetsPerDocument {
201
+ min: number;
202
+ max: number;
203
+ mean: number;
204
+ median: number;
205
+ p95: number;
206
+ }
207
+ export interface StatsSmartSnippets {
208
+ /**
209
+ * Total number of valid documents
210
+ */
211
+ documentCount: number;
212
+ /**
213
+ * Number of documents with duplicated ID
214
+ */
215
+ documentWithDuplicatedIdCount: number;
216
+ /**
217
+ * Number of invalid HTML documents
218
+ */
219
+ invalidHtmlDocumentCount: number;
220
+ /**
221
+ * Number of documents with snippets
222
+ */
223
+ documentWithSnippetCount: number;
224
+ /**
225
+ * Number of documents without permanent ID
226
+ */
227
+ documentWithoutIdCount: number;
228
+ /**
229
+ * Ratio of documents with at least 1 snippet / total valid documents
230
+ */
231
+ documentWithSnippetRatio: number;
232
+ /**
233
+ * Number of available snippets
234
+ */
235
+ snippetCount: number;
236
+ /**
237
+ * Snippets stats per document
238
+ */
239
+ snippetsPerDocument: SnippetsPerDocument;
240
+ }
241
+ export interface PreparationStatsSS extends StatsSmartSnippets {
242
+ /**
243
+ * Additional statistic per source
244
+ */
245
+ statsPerSource: Record<string, StatsSmartSnippets>;
246
+ }
197
247
  export interface ModelInformationSS {
198
248
  metaInfo: MetaInfoSS;
199
249
  modelBuildingStats: BuildingStatsSS;
250
+ preparationStats: PreparationStatsSS;
200
251
  }
201
252
  export interface DatasetFieldDetails {
202
253
  numSamples: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coveo/platform-client",
3
- "version": "40.9.3",
3
+ "version": "40.11.0",
4
4
  "description": "",
5
5
  "type": "module",
6
6
  "exports": {
@@ -32,29 +32,29 @@
32
32
  "prepare": "husky install"
33
33
  },
34
34
  "devDependencies": {
35
- "@commitlint/cli": "17.4.2",
36
- "@commitlint/config-conventional": "17.4.2",
37
- "@types/jest": "29.2.6",
38
- "@typescript-eslint/eslint-plugin": "5.48.2",
39
- "@typescript-eslint/parser": "5.48.2",
35
+ "@commitlint/cli": "17.4.4",
36
+ "@commitlint/config-conventional": "17.4.4",
37
+ "@types/jest": "29.4.0",
38
+ "@typescript-eslint/eslint-plugin": "5.53.0",
39
+ "@typescript-eslint/parser": "5.53.0",
40
40
  "abortcontroller-polyfill": "1.7.5",
41
41
  "cz-conventional-changelog": "3.3.0",
42
- "eslint": "8.32.0",
42
+ "eslint": "8.34.0",
43
43
  "eslint-config-prettier": "8.6.0",
44
44
  "eslint-config-typescript": "3.0.0",
45
45
  "eslint-plugin-jest": "27.2.1",
46
46
  "eslint-plugin-prettier": "4.2.1",
47
47
  "husky": "8.0.3",
48
- "jest": "29.3.1",
48
+ "jest": "29.4.3",
49
49
  "jest-fetch-mock": "3.0.3",
50
50
  "jest-runner-eslint": "1.1.0",
51
- "lint-staged": "13.1.0",
52
- "prettier": "2.8.3",
53
- "semantic-release": "20.0.3",
51
+ "lint-staged": "13.1.2",
52
+ "prettier": "2.8.4",
53
+ "semantic-release": "20.1.0",
54
54
  "ts-jest": "29.0.5",
55
55
  "tsjs": "4.2.1",
56
- "tslib": "2.4.1",
57
- "typescript": "4.9.4"
56
+ "tslib": "2.5.0",
57
+ "typescript": "4.9.5"
58
58
  },
59
59
  "prettier": "tsjs/prettier-config",
60
60
  "lint-staged": {