@coveo/platform-client 35.1.0 → 35.2.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 (4) hide show
  1. package/dist/definitions/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.d.ts +36 -1
  2. package/dist/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.js +11 -1
  3. package/dist/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.js.map +1 -1
  4. package/package.json +6 -6
package/dist/definitions/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.d.ts CHANGED
@@ -79,7 +79,8 @@ export declare enum ResourceSnapshotsReportResultCode {
79
79
  NoResourceRetrieved = "NO_RESOURCE_RETRIEVED",
80
80
  UnableToRetrieveResources = "UNABLE_TO_RETRIEVE_RESOURCES",
81
81
  ResourceDependencyCyle = "RESOURCE_DEPENDENCY_CYCLE",
82
- ExternalServiceCommunicationError = "EXTERNAL_SERVICE_COMMUNICATION_ERROR"
82
+ ExternalServiceCommunicationError = "EXTERNAL_SERVICE_COMMUNICATION_ERROR",
83
+ AutoSynchronizationFailure = "AUTO_SYNCHRONIZATION_FAILURE"
83
84
  }
84
85
  export declare enum ResourceSnapshotsReportStatus {
85
86
  Pending = "PENDING",
@@ -144,7 +145,33 @@ export interface ResourceSnapshotsReportOperationResult {
144
145
  message: string;
145
146
  }
146
147
  export declare type ResourceSnapshotsReportOperationResults = Record<string, ResourceSnapshotsReportOperationResult[]>;
148
+ export declare enum SnapshotsReportStages {
149
+ COMPUTING_OPERATIONS = "COMPUTING_OPERATIONS",
150
+ CREATING_SNAPSHOT = "CREATING_SNAPSHOT",
151
+ INITIAL_PROCESSING = "INITIAL_PROCESSING",
152
+ PERFORMING_OPERATIONS = "PERFORMING_OPERATIONS",
153
+ SYNCHRONIZING = "SYNCHRONIZING",
154
+ VALIDATING_OPERATIONS = "VALIDATING_OPERATIONS"
155
+ }
147
156
  export interface ResourceSnapshotsReportModel {
157
+ /**
158
+ * Current stage of the report
159
+ */
160
+ currentStage?: {
161
+ /**
162
+ * The progress type of the current step
163
+ */
164
+ progressType: 'BINARY' | 'PERCENTAGE';
165
+ /**
166
+ * The progress value of the current step
167
+ * The value can be percentage type (from 0 to 100) binary type (0 or 1)
168
+ */
169
+ progressValue: number;
170
+ /**
171
+ * Current step name
172
+ */
173
+ stage: SnapshotsReportStages;
174
+ };
148
175
  /**
149
176
  * The unique identifier of the report.
150
177
  */
@@ -165,6 +192,14 @@ export interface ResourceSnapshotsReportModel {
165
192
  * The result code of the snapshot event, if applicable.
166
193
  */
167
194
  resultCode: ResourceSnapshotsReportResultCode;
195
+ /**
196
+ * The ordered stages the migration operation has to go through in order to complete.
197
+ */
198
+ stagesToExecute: SnapshotsReportStages[];
199
+ /**
200
+ * The start date ot the report in number of milliseconds since UNIX epoch.
201
+ */
202
+ startDate: number;
168
203
  /**
169
204
  * The status of the snapshot.
170
205
  */
package/dist/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ApplyOptionsDeletionScope = exports.ResourceSnapshotContentType = exports.ResourceSnapshotSupportedFileTypes = exports.ResourceSnapshotsReportType = exports.ResourceSnapshotsSynchronizationPlanStatus = exports.ResourceSnapshotsReportStatus = exports.ResourceSnapshotsReportResultCode = exports.SnapshotExportContentFormat = exports.SnapshotAccessType = exports.ResourceSnapshotType = void 0;
3
+ exports.ApplyOptionsDeletionScope = exports.SnapshotsReportStages = exports.ResourceSnapshotContentType = exports.ResourceSnapshotSupportedFileTypes = exports.ResourceSnapshotsReportType = exports.ResourceSnapshotsSynchronizationPlanStatus = exports.ResourceSnapshotsReportStatus = exports.ResourceSnapshotsReportResultCode = exports.SnapshotExportContentFormat = exports.SnapshotAccessType = exports.ResourceSnapshotType = void 0;
4
4
  /*
5
5
  * 'Resource' is defined as anything uniquely identified on the platform's domain that can be created, updated or deleted
6
6
  */
@@ -47,6 +47,7 @@ var ResourceSnapshotsReportResultCode;
47
47
  ResourceSnapshotsReportResultCode["UnableToRetrieveResources"] = "UNABLE_TO_RETRIEVE_RESOURCES";
48
48
  ResourceSnapshotsReportResultCode["ResourceDependencyCyle"] = "RESOURCE_DEPENDENCY_CYCLE";
49
49
  ResourceSnapshotsReportResultCode["ExternalServiceCommunicationError"] = "EXTERNAL_SERVICE_COMMUNICATION_ERROR";
50
+ ResourceSnapshotsReportResultCode["AutoSynchronizationFailure"] = "AUTO_SYNCHRONIZATION_FAILURE";
50
51
  })(ResourceSnapshotsReportResultCode = exports.ResourceSnapshotsReportResultCode || (exports.ResourceSnapshotsReportResultCode = {}));
51
52
  var ResourceSnapshotsReportStatus;
52
53
  (function (ResourceSnapshotsReportStatus) {
@@ -79,6 +80,15 @@ var ResourceSnapshotContentType;
79
80
  ResourceSnapshotContentType["PRIMARY"] = "PRIMARY";
80
81
  ResourceSnapshotContentType["CURRENT_STATE"] = "CURRENT_STATE";
81
82
  })(ResourceSnapshotContentType = exports.ResourceSnapshotContentType || (exports.ResourceSnapshotContentType = {}));
83
+ var SnapshotsReportStages;
84
+ (function (SnapshotsReportStages) {
85
+ SnapshotsReportStages["COMPUTING_OPERATIONS"] = "COMPUTING_OPERATIONS";
86
+ SnapshotsReportStages["CREATING_SNAPSHOT"] = "CREATING_SNAPSHOT";
87
+ SnapshotsReportStages["INITIAL_PROCESSING"] = "INITIAL_PROCESSING";
88
+ SnapshotsReportStages["PERFORMING_OPERATIONS"] = "PERFORMING_OPERATIONS";
89
+ SnapshotsReportStages["SYNCHRONIZING"] = "SYNCHRONIZING";
90
+ SnapshotsReportStages["VALIDATING_OPERATIONS"] = "VALIDATING_OPERATIONS";
91
+ })(SnapshotsReportStages = exports.SnapshotsReportStages || (exports.SnapshotsReportStages = {}));
82
92
  var ApplyOptionsDeletionScope;
83
93
  (function (ApplyOptionsDeletionScope) {
84
94
  ApplyOptionsDeletionScope["AllManagedResources"] = "ALL_MANAGED_RESOURCES";
package/dist/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ResourceSnapshotsInterfaces.js","sourceRoot":"","sources":["../../../src/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.ts"],"names":[],"mappings":";;;AA6CA;;GAEG;AACH,IAAY,oBAoBX;AApBD,WAAY,oBAAoB;IAC5B,+CAAuB,CAAA;IACvB,0DAAkC,CAAA;IAClC,uCAAe,CAAA;IACf,yCAAiB,CAAA;IACjB,2CAAmB,CAAA;IACnB,4CAAoB,CAAA;IACpB,mEAA2C,CAAA;IAC3C,0DAAkC,CAAA;IAClC,wDAAgC,CAAA;IAChC,2EAAmD,CAAA;IACnD,gEAAwC,CAAA;IACxC,wDAAgC,CAAA;IAChC,kDAA0B,CAAA;IAC1B,8DAAsC,CAAA;IACtC,yCAAiB,CAAA;IACjB,8CAAsB,CAAA;IACtB,qDAA6B,CAAA;IAC7B,+CAAuB,CAAA;IACvB,2CAAmB,CAAA;AACvB,CAAC,EApBW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAoB/B;AAED,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC1B,mCAAa,CAAA;IACb,qCAAe,CAAA;AACnB,CAAC,EAHW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAG7B;AAED,IAAY,2BAGX;AAHD,WAAY,2BAA2B;IACnC,4CAAa,CAAA;IACb,8DAA+B,CAAA;AACnC,CAAC,EAHW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAGtC;AAED,IAAY,iCAUX;AAVD,WAAY,iCAAiC;IACzC,mEAA8B,CAAA;IAC9B,4EAAuC,CAAA;IACvC,wDAAmB,CAAA;IACnB,yEAAoC,CAAA;IACpC,kGAA6D,CAAA;IAC7D,kFAA6C,CAAA;IAC7C,+FAA0D,CAAA;IAC1D,yFAAoD,CAAA;IACpD,+GAA0E,CAAA;AAC9E,CAAC,EAVW,iCAAiC,GAAjC,yCAAiC,KAAjC,yCAAiC,QAU5C;AAED,IAAY,6BAKX;AALD,WAAY,6BAA6B;IACrC,oDAAmB,CAAA;IACnB,2DAA0B,CAAA;IAC1B,wDAAuB,CAAA;IACvB,oDAAmB,CAAA;AACvB,CAAC,EALW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAKxC;AAED,IAAY,0CAIX;AAJD,WAAY,0CAA0C;IAClD,mEAAqB,CAAA;IACrB,iEAAmB,CAAA;IACnB,kEAAoB,CAAA;AACxB,CAAC,EAJW,0CAA0C,GAA1C,kDAA0C,KAA1C,kDAA0C,QAIrD;AAED,IAAY,2BAMX;AAND,WAAY,2BAA2B;IACnC,iEAAkC,CAAA;IAClC,iDAAkB,CAAA;IAClB,8CAAe,CAAA;IACf,wFAAyD,CAAA;IACzD,sFAAuD,CAAA;AAC3D,CAAC,EANW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAMtC;AAED,IAAY,kCAGX;AAHD,WAAY,kCAAkC;IAC1C,iDAAW,CAAA;IACX,mDAAa,CAAA;AACjB,CAAC,EAHW,kCAAkC,GAAlC,0CAAkC,KAAlC,0CAAkC,QAG7C;AAED,IAAY,2BAGX;AAHD,WAAY,2BAA2B;IACnC,kDAAmB,CAAA;IACnB,8DAA+B,CAAA;AACnC,CAAC,EAHW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAGtC;AAwLD,IAAY,yBAGX;AAHD,WAAY,yBAAyB;IACjC,0EAA6C,CAAA;IAC7C,+EAAkD,CAAA;AACtD,CAAC,EAHW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAGpC"}
1
+ {"version":3,"file":"ResourceSnapshotsInterfaces.js","sourceRoot":"","sources":["../../../src/resources/ResourceSnapshots/ResourceSnapshotsInterfaces.ts"],"names":[],"mappings":";;;AA6CA;;GAEG;AACH,IAAY,oBAoBX;AApBD,WAAY,oBAAoB;IAC5B,+CAAuB,CAAA;IACvB,0DAAkC,CAAA;IAClC,uCAAe,CAAA;IACf,yCAAiB,CAAA;IACjB,2CAAmB,CAAA;IACnB,4CAAoB,CAAA;IACpB,mEAA2C,CAAA;IAC3C,0DAAkC,CAAA;IAClC,wDAAgC,CAAA;IAChC,2EAAmD,CAAA;IACnD,gEAAwC,CAAA;IACxC,wDAAgC,CAAA;IAChC,kDAA0B,CAAA;IAC1B,8DAAsC,CAAA;IACtC,yCAAiB,CAAA;IACjB,8CAAsB,CAAA;IACtB,qDAA6B,CAAA;IAC7B,+CAAuB,CAAA;IACvB,2CAAmB,CAAA;AACvB,CAAC,EApBW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAoB/B;AAED,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC1B,mCAAa,CAAA;IACb,qCAAe,CAAA;AACnB,CAAC,EAHW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAG7B;AAED,IAAY,2BAGX;AAHD,WAAY,2BAA2B;IACnC,4CAAa,CAAA;IACb,8DAA+B,CAAA;AACnC,CAAC,EAHW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAGtC;AAED,IAAY,iCAWX;AAXD,WAAY,iCAAiC;IACzC,mEAA8B,CAAA;IAC9B,4EAAuC,CAAA;IACvC,wDAAmB,CAAA;IACnB,yEAAoC,CAAA;IACpC,kGAA6D,CAAA;IAC7D,kFAA6C,CAAA;IAC7C,+FAA0D,CAAA;IAC1D,yFAAoD,CAAA;IACpD,+GAA0E,CAAA;IAC1E,gGAA2D,CAAA;AAC/D,CAAC,EAXW,iCAAiC,GAAjC,yCAAiC,KAAjC,yCAAiC,QAW5C;AAED,IAAY,6BAKX;AALD,WAAY,6BAA6B;IACrC,oDAAmB,CAAA;IACnB,2DAA0B,CAAA;IAC1B,wDAAuB,CAAA;IACvB,oDAAmB,CAAA;AACvB,CAAC,EALW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAKxC;AAED,IAAY,0CAIX;AAJD,WAAY,0CAA0C;IAClD,mEAAqB,CAAA;IACrB,iEAAmB,CAAA;IACnB,kEAAoB,CAAA;AACxB,CAAC,EAJW,0CAA0C,GAA1C,kDAA0C,KAA1C,kDAA0C,QAIrD;AAED,IAAY,2BAMX;AAND,WAAY,2BAA2B;IACnC,iEAAkC,CAAA;IAClC,iDAAkB,CAAA;IAClB,8CAAe,CAAA;IACf,wFAAyD,CAAA;IACzD,sFAAuD,CAAA;AAC3D,CAAC,EANW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAMtC;AAED,IAAY,kCAGX;AAHD,WAAY,kCAAkC;IAC1C,iDAAW,CAAA;IACX,mDAAa,CAAA;AACjB,CAAC,EAHW,kCAAkC,GAAlC,0CAAkC,KAAlC,0CAAkC,QAG7C;AAED,IAAY,2BAGX;AAHD,WAAY,2BAA2B;IACnC,kDAAmB,CAAA;IACnB,8DAA+B,CAAA;AACnC,CAAC,EAHW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAGtC;AA0CD,IAAY,qBAOX;AAPD,WAAY,qBAAqB;IAC7B,sEAA6C,CAAA;IAC7C,gEAAuC,CAAA;IACvC,kEAAyC,CAAA;IACzC,wEAA+C,CAAA;IAC/C,wDAA+B,CAAA;IAC/B,wEAA+C,CAAA;AACnD,CAAC,EAPW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAOhC;AA0KD,IAAY,yBAGX;AAHD,WAAY,yBAAyB;IACjC,0EAA6C,CAAA;IAC7C,+EAAkD,CAAA;AACtD,CAAC,EAHW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAGpC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coveo/platform-client",
3
- "version": "35.1.0",
3
+ "version": "35.2.0",
4
4
  "description": "",
5
5
  "main": "dist/Entry.js",
6
6
  "types": "dist/definitions/Entry.d.ts",
@@ -26,18 +26,18 @@
26
26
  "devDependencies": {
27
27
  "@commitlint/cli": "17.1.2",
28
28
  "@commitlint/config-conventional": "17.1.0",
29
- "@types/jest": "29.1.2",
30
- "@typescript-eslint/eslint-plugin": "5.40.0",
31
- "@typescript-eslint/parser": "5.40.0",
29
+ "@types/jest": "29.2.0",
30
+ "@typescript-eslint/eslint-plugin": "5.40.1",
31
+ "@typescript-eslint/parser": "5.40.1",
32
32
  "abortcontroller-polyfill": "1.7.5",
33
33
  "cz-conventional-changelog": "3.3.0",
34
34
  "eslint": "8.25.0",
35
35
  "eslint-config-prettier": "8.5.0",
36
36
  "eslint-config-typescript": "3.0.0",
37
- "eslint-plugin-jest": "27.1.1",
37
+ "eslint-plugin-jest": "27.1.2",
38
38
  "eslint-plugin-prettier": "4.2.1",
39
39
  "husky": "8.0.1",
40
- "jest": "29.1.2",
40
+ "jest": "29.2.1",
41
41
  "jest-fetch-mock": "3.0.3",
42
42
  "jest-runner-eslint": "1.1.0",
43
43
  "lint-staged": "13.0.3",