@inweb/client 26.1.2 → 26.1.4
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.
- package/dist/client.js +434 -449
- package/dist/client.js.map +1 -1
- package/dist/client.min.js +1 -1
- package/dist/client.module.js +35 -35
- package/dist/client.module.js.map +1 -1
- package/lib/Api/Assembly.d.ts +65 -69
- package/lib/Api/ClashTest.d.ts +16 -16
- package/lib/Api/Client.d.ts +78 -77
- package/lib/Api/Endpoint.d.ts +6 -6
- package/lib/Api/FetchError.d.ts +5 -5
- package/lib/Api/File.d.ts +120 -132
- package/lib/Api/IHttpClient.d.ts +4 -3
- package/lib/Api/IRole.d.ts +6 -6
- package/lib/Api/ISharedLink.d.ts +1 -1
- package/lib/Api/IUser.d.ts +4 -4
- package/lib/Api/Job.d.ts +12 -12
- package/lib/Api/Member.d.ts +6 -6
- package/lib/Api/Model.d.ts +18 -18
- package/lib/Api/OAuthClient.d.ts +10 -10
- package/lib/Api/Permission.d.ts +17 -20
- package/lib/Api/Project.d.ts +14 -13
- package/lib/Api/Role.d.ts +2 -2
- package/lib/Api/SharedLink.d.ts +2 -2
- package/lib/Api/User.d.ts +33 -31
- package/package.json +2 -2
- package/src/Api/Assembly.ts +66 -70
- package/src/Api/ClashTest.ts +16 -16
- package/src/Api/Client.ts +78 -77
- package/src/Api/Endpoint.ts +6 -6
- package/src/Api/FetchError.ts +5 -5
- package/src/Api/File.ts +121 -133
- package/src/Api/IHttpClient.ts +4 -3
- package/src/Api/IRole.ts +6 -6
- package/src/Api/ISharedLink.ts +1 -1
- package/src/Api/IUser.ts +4 -4
- package/src/Api/Job.ts +12 -12
- package/src/Api/Member.ts +6 -6
- package/src/Api/Model.ts +18 -18
- package/src/Api/OAuthClient.ts +10 -10
- package/src/Api/Permission.ts +17 -20
- package/src/Api/Project.ts +14 -13
- package/src/Api/Role.ts +2 -2
- package/src/Api/SharedLink.ts +2 -2
- package/src/Api/User.ts +33 -31
package/dist/client.js
CHANGED
|
@@ -32,8 +32,8 @@
|
|
|
32
32
|
class Endpoint {
|
|
33
33
|
/**
|
|
34
34
|
* @ignore
|
|
35
|
-
* @param path - The API path of the endpoint relative to the REST API server URL of the
|
|
36
|
-
* client.
|
|
35
|
+
* @param path - The API path of the endpoint relative to the REST API server URL of the
|
|
36
|
+
* specified HTTP client.
|
|
37
37
|
* @param httpClient - HTTP client instance used to send requests to the REST API server.
|
|
38
38
|
* @param headers - Endpoint-specific HTTP headers.
|
|
39
39
|
*/
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
* @ignore
|
|
64
64
|
* @param relativePath - Nested endpoint relative path.
|
|
65
65
|
* @param signal - An
|
|
66
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
67
|
-
* to communicate with a fetch request and abort it if desired.
|
|
66
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
67
|
+
* signal. Allows to communicate with a fetch request and abort it if desired.
|
|
68
68
|
*/
|
|
69
69
|
get(relativePath, signal) {
|
|
70
70
|
return this.httpClient.get(this.getEndpointPath(relativePath), { signal, headers: this.headers });
|
|
@@ -210,14 +210,14 @@
|
|
|
210
210
|
}
|
|
211
211
|
}
|
|
212
212
|
/**
|
|
213
|
-
* The `FetchError` object indicates an error when request to Open Cloud Server could not be
|
|
214
|
-
* `FetchError` is typically (but not exclusively) thrown when a network error
|
|
215
|
-
* object not found.
|
|
213
|
+
* The `FetchError` object indicates an error when request to Open Cloud Server could not be
|
|
214
|
+
* performed. A `FetchError` is typically (but not exclusively) thrown when a network error
|
|
215
|
+
* occurs, access denied, or object not found.
|
|
216
216
|
*/
|
|
217
217
|
class FetchError extends Error {
|
|
218
218
|
/**
|
|
219
|
-
* @property status - The
|
|
220
|
-
* of the response.
|
|
219
|
+
* @property status - The
|
|
220
|
+
* {@link https://developer.mozilla.org/docs/Web/HTTP/Status | HTTP status code} of the response.
|
|
221
221
|
* @property message - Error message.
|
|
222
222
|
*/
|
|
223
223
|
constructor(status, message) {
|
|
@@ -252,8 +252,8 @@
|
|
|
252
252
|
///////////////////////////////////////////////////////////////////////////////
|
|
253
253
|
/**
|
|
254
254
|
* Provides properties and methods for working with view of the {@link File | file} or
|
|
255
|
-
* {@link Assembly| assembly}. For example, for `dwg` it is a `Model` space or layout, and for
|
|
256
|
-
* it is a `3D` view.
|
|
255
|
+
* {@link Assembly| assembly}. For example, for `dwg` it is a `Model` space or layout, and for
|
|
256
|
+
* `rvt` files it is a `3D` view.
|
|
257
257
|
*/
|
|
258
258
|
class Model extends Endpoint {
|
|
259
259
|
/**
|
|
@@ -285,8 +285,8 @@
|
|
|
285
285
|
this._data = value;
|
|
286
286
|
}
|
|
287
287
|
/**
|
|
288
|
-
* Scene description resource file name. Use {@link downloadResource | downloadResource()} to
|
|
289
|
-
* scene description file.
|
|
288
|
+
* Scene description resource file name. Use {@link downloadResource | downloadResource()} to
|
|
289
|
+
* download scene description file.
|
|
290
290
|
*
|
|
291
291
|
* @readonly
|
|
292
292
|
*/
|
|
@@ -318,8 +318,8 @@
|
|
|
318
318
|
return this.data.fileId;
|
|
319
319
|
}
|
|
320
320
|
/**
|
|
321
|
-
* The list of geometry data resource files. Use {@link downloadResource | downloadResource()}
|
|
322
|
-
* download geometry data files.
|
|
321
|
+
* The list of geometry data resource files. Use {@link downloadResource | downloadResource()}
|
|
322
|
+
* to download geometry data files.
|
|
323
323
|
*
|
|
324
324
|
* @readonly
|
|
325
325
|
*/
|
|
@@ -387,8 +387,8 @@
|
|
|
387
387
|
.then((array) => array.filter(({ custom_fields = {} }) => custom_fields.modelId === this.id || custom_fields.modelName === this.name));
|
|
388
388
|
}
|
|
389
389
|
/**
|
|
390
|
-
* Saves a new model owner file/assembly viewpoint to the server. To create a new viewpoint
|
|
391
|
-
* `Viewer.createViewpoint()`.
|
|
390
|
+
* Saves a new model owner file/assembly viewpoint to the server. To create a new viewpoint
|
|
391
|
+
* use `Viewer.createViewpoint()`.
|
|
392
392
|
*
|
|
393
393
|
* @param viewpoint - Viewpoint object.
|
|
394
394
|
*/
|
|
@@ -426,29 +426,29 @@
|
|
|
426
426
|
return this._file.getSnapshotData(guid, bitmapGuid);
|
|
427
427
|
}
|
|
428
428
|
/**
|
|
429
|
-
* Downloads a resource file. Resource files are files that contain model scene descriptions,
|
|
430
|
-
* geometry data.
|
|
429
|
+
* Downloads a resource file. Resource files are files that contain model scene descriptions,
|
|
430
|
+
* or geometry data.
|
|
431
431
|
*
|
|
432
432
|
* @param dataId - Resource file name.
|
|
433
433
|
* @param onProgress - Download progress callback.
|
|
434
434
|
* @param signal - An
|
|
435
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
436
|
-
* to communicate with a fetch request and abort it if desired.
|
|
435
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
436
|
+
* signal. Allows to communicate with a fetch request and abort it if desired.
|
|
437
437
|
*/
|
|
438
438
|
downloadResource(dataId, onProgress, signal) {
|
|
439
439
|
return this._file.downloadResource(dataId, onProgress, signal);
|
|
440
440
|
}
|
|
441
441
|
/**
|
|
442
|
-
* Downloads a part of resource file. Resource files are files that contain model scene
|
|
443
|
-
* or geometry data.
|
|
442
|
+
* Downloads a part of resource file. Resource files are files that contain model scene
|
|
443
|
+
* descriptions, or geometry data.
|
|
444
444
|
*
|
|
445
445
|
* @param dataId - Resource file name.
|
|
446
446
|
* @param ranges - A range of resource file contents to download.
|
|
447
447
|
* @param requestId - Request ID for download progress callback.
|
|
448
448
|
* @param onProgress - Download progress callback.
|
|
449
449
|
* @param signal - An
|
|
450
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
451
|
-
* to communicate with a fetch request and abort it if desired.
|
|
450
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
451
|
+
* signal. Allows to communicate with a fetch request and abort it if desired.
|
|
452
452
|
*/
|
|
453
453
|
downloadResourceRange(dataId, requestId, ranges, onProgress, signal) {
|
|
454
454
|
return this._file.downloadResourceRange(dataId, requestId, ranges, onProgress, signal);
|
|
@@ -493,8 +493,8 @@
|
|
|
493
493
|
* References are images, fonts, or any other files to correct rendering of the file.
|
|
494
494
|
*
|
|
495
495
|
* @param signal - An
|
|
496
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
497
|
-
* can be used to abort waiting as desired.
|
|
496
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
497
|
+
* signal, which can be used to abort waiting as desired.
|
|
498
498
|
*/
|
|
499
499
|
getReferences(signal) {
|
|
500
500
|
return this._file.getReferences(signal);
|
|
@@ -541,9 +541,9 @@
|
|
|
541
541
|
var _a, _b, _c;
|
|
542
542
|
const timeout = params.timeout || 600000;
|
|
543
543
|
const interval = params.interval || 3000;
|
|
544
|
-
const signal = (_a = params.signal) !== null && _a !==
|
|
545
|
-
const abortError = (_b = params.abortError) !== null && _b !==
|
|
546
|
-
const timeoutError = (_c = params.timeoutError) !== null && _c !==
|
|
544
|
+
const signal = (_a = params.signal) !== null && _a !== void 0 ? _a : new AbortController().signal;
|
|
545
|
+
const abortError = (_b = params.abortError) !== null && _b !== void 0 ? _b : new DOMException("Aborted", "AbortError");
|
|
546
|
+
const timeoutError = (_c = params.timeoutError) !== null && _c !== void 0 ? _c : new DOMException("Timeout", "TimeoutError");
|
|
547
547
|
const end = performance.now() + timeout;
|
|
548
548
|
let count = timeout / interval;
|
|
549
549
|
do {
|
|
@@ -574,9 +574,9 @@
|
|
|
574
574
|
function userFullName(firstName, lastName = "", userName = "") {
|
|
575
575
|
var _a;
|
|
576
576
|
if (firstName && typeof firstName !== "string") {
|
|
577
|
-
return userFullName((_a = firstName.firstName) !== null && _a !==
|
|
577
|
+
return userFullName((_a = firstName.firstName) !== null && _a !== void 0 ? _a : firstName.name, firstName.lastName, firstName.userName);
|
|
578
578
|
}
|
|
579
|
-
return `${firstName !== null && firstName !==
|
|
579
|
+
return `${firstName !== null && firstName !== void 0 ? firstName : ""} ${lastName !== null && lastName !== void 0 ? lastName : ""}`.trim() || userName;
|
|
580
580
|
}
|
|
581
581
|
function userInitials(fullName = "") {
|
|
582
582
|
const names = fullName.split(" ").filter((x) => x);
|
|
@@ -628,10 +628,10 @@
|
|
|
628
628
|
/**
|
|
629
629
|
* The type of the clashes that the test detects:
|
|
630
630
|
*
|
|
631
|
-
* - `true` - Сlearance clash. A clash in which the object A may or may not intersect with
|
|
632
|
-
* comes within a distance of less than the {@link tolerance}.
|
|
633
|
-
* - `false` - Hard clash. A clash in which the object A intersects with object B by a distance
|
|
634
|
-
* than the {@link tolerance}.
|
|
631
|
+
* - `true` - Сlearance clash. A clash in which the object A may or may not intersect with
|
|
632
|
+
* object B, but comes within a distance of less than the {@link tolerance}.
|
|
633
|
+
* - `false` - Hard clash. A clash in which the object A intersects with object B by a distance
|
|
634
|
+
* of more than the {@link tolerance}.
|
|
635
635
|
*
|
|
636
636
|
* @readonly
|
|
637
637
|
*/
|
|
@@ -697,8 +697,8 @@
|
|
|
697
697
|
return this.data.owner;
|
|
698
698
|
}
|
|
699
699
|
/**
|
|
700
|
-
* First selection set for clash detection. Objects from `selectionSetA` will be tested
|
|
701
|
-
* others by objects from the `selectionSetB` during the test.
|
|
700
|
+
* First selection set for clash detection. Objects from `selectionSetA` will be tested
|
|
701
|
+
* against each others by objects from the `selectionSetB` during the test.
|
|
702
702
|
*
|
|
703
703
|
* @readonly
|
|
704
704
|
*/
|
|
@@ -719,8 +719,8 @@
|
|
|
719
719
|
return this.data.selectionTypeA;
|
|
720
720
|
}
|
|
721
721
|
/**
|
|
722
|
-
* Second selection set for clash detection. Objects from `selectionSetB` will be tested
|
|
723
|
-
* others by objects from the `selectionSetA` during the test.
|
|
722
|
+
* Second selection set for clash detection. Objects from `selectionSetB` will be tested
|
|
723
|
+
* against each others by objects from the `selectionSetA` during the test.
|
|
724
724
|
*
|
|
725
725
|
* @readonly
|
|
726
726
|
*/
|
|
@@ -785,8 +785,8 @@
|
|
|
785
785
|
return super.delete("").then((response) => response.json());
|
|
786
786
|
}
|
|
787
787
|
/**
|
|
788
|
-
* Saves test properties changes to the server. Call this method to update test data on the
|
|
789
|
-
* after any property changes.
|
|
788
|
+
* Saves test properties changes to the server. Call this method to update test data on the
|
|
789
|
+
* server after any property changes.
|
|
790
790
|
*/
|
|
791
791
|
save() {
|
|
792
792
|
return this.update(this.data);
|
|
@@ -795,20 +795,20 @@
|
|
|
795
795
|
* Waits for test to complete. Test is done when it changes to `done` or `failed` status.
|
|
796
796
|
*
|
|
797
797
|
* @param params - An object containing waiting parameters.
|
|
798
|
-
* @param params.timeout - The time, in milliseconds that the function should wait test. If
|
|
799
|
-
* complete during this time, the `TimeoutError` exception will be thrown.
|
|
800
|
-
* @param params.interval - The time, in milliseconds, the function should delay in between
|
|
801
|
-
* test status.
|
|
798
|
+
* @param params.timeout - The time, in milliseconds that the function should wait test. If
|
|
799
|
+
* test is not complete during this time, the `TimeoutError` exception will be thrown.
|
|
800
|
+
* @param params.interval - The time, in milliseconds, the function should delay in between
|
|
801
|
+
* checking test status.
|
|
802
802
|
* @param params.signal - An
|
|
803
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
804
|
-
* can be used to abort waiting as desired.
|
|
803
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
804
|
+
* signal, which can be used to abort waiting as desired.
|
|
805
805
|
* @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
|
|
806
806
|
*/
|
|
807
807
|
waitForDone(params) {
|
|
808
808
|
const checkDone = () => this.checkout().then((test) => {
|
|
809
809
|
var _a;
|
|
810
810
|
const ready = ["done", "failed"].includes(test.status);
|
|
811
|
-
const cancel = (_a = params === null || params ===
|
|
811
|
+
const cancel = (_a = params === null || params === void 0 ? void 0 : params.onCheckout) === null || _a === void 0 ? void 0 : _a.call(params, test, ready);
|
|
812
812
|
return cancel || ready;
|
|
813
813
|
});
|
|
814
814
|
return waitFor(checkDone, params).then(() => this);
|
|
@@ -844,8 +844,8 @@
|
|
|
844
844
|
// acknowledge and accept the above terms.
|
|
845
845
|
///////////////////////////////////////////////////////////////////////////////
|
|
846
846
|
/**
|
|
847
|
-
* Provides properties and methods for obtaining information about an assembly on the Open
|
|
848
|
-
* and managing its data.
|
|
847
|
+
* Provides properties and methods for obtaining information about an assembly on the Open
|
|
848
|
+
* Cloud Server and managing its data.
|
|
849
849
|
*/
|
|
850
850
|
class Assembly extends Endpoint {
|
|
851
851
|
/**
|
|
@@ -893,7 +893,7 @@
|
|
|
893
893
|
this._data.owner.fullName = userFullName(this._data.owner);
|
|
894
894
|
this._data.owner.initials = userInitials(this._data.owner.fullName);
|
|
895
895
|
// associatedFiles since 23.12
|
|
896
|
-
(_a = (_b = this._data).associatedFiles) !== null && _a !==
|
|
896
|
+
(_a = (_b = this._data).associatedFiles) !== null && _a !== void 0 ? _a : (_b.associatedFiles = []);
|
|
897
897
|
this._data.associatedFiles.forEach((file) => (file.link = `${this.httpClient.serverUrl}/files/${file.fileId}`));
|
|
898
898
|
}
|
|
899
899
|
/**
|
|
@@ -1009,8 +1009,8 @@
|
|
|
1009
1009
|
return super.delete("").then((response) => response.json());
|
|
1010
1010
|
}
|
|
1011
1011
|
/**
|
|
1012
|
-
* Saves assembly properties changes to the server. Call this method to update assembly data
|
|
1013
|
-
* server after any property changes.
|
|
1012
|
+
* Saves assembly properties changes to the server. Call this method to update assembly data
|
|
1013
|
+
* on the server after any property changes.
|
|
1014
1014
|
*/
|
|
1015
1015
|
save() {
|
|
1016
1016
|
return this.update(this.data);
|
|
@@ -1061,41 +1061,35 @@
|
|
|
1061
1061
|
/**
|
|
1062
1062
|
* Returns the properties for an objects in the assembly.
|
|
1063
1063
|
*
|
|
1064
|
-
* @param handles - Object original handle or handles array. Specify `undefined` to get
|
|
1065
|
-
* all objects in the assembly.
|
|
1064
|
+
* @param handles - Object original handle or handles array. Specify `undefined` to get
|
|
1065
|
+
* properties for all objects in the assembly.
|
|
1066
1066
|
*/
|
|
1067
1067
|
getProperties(handles) {
|
|
1068
1068
|
const relativePath = handles !== undefined ? `/properties?handles=${handles}` : "/properties";
|
|
1069
1069
|
return this.get(relativePath).then((response) => response.json());
|
|
1070
1070
|
}
|
|
1071
1071
|
/**
|
|
1072
|
-
* Returns the list of original handles for an objects in the file that match the specified
|
|
1073
|
-
* Search patterns may be combined using query operators.
|
|
1074
|
-
*
|
|
1075
|
-
* @example Simple search pattern
|
|
1076
|
-
*
|
|
1077
|
-
*
|
|
1078
|
-
*
|
|
1079
|
-
*
|
|
1080
|
-
*
|
|
1081
|
-
*
|
|
1082
|
-
*
|
|
1083
|
-
*
|
|
1084
|
-
*
|
|
1085
|
-
*
|
|
1086
|
-
*
|
|
1087
|
-
*
|
|
1088
|
-
*
|
|
1089
|
-
*
|
|
1090
|
-
*
|
|
1091
|
-
*
|
|
1092
|
-
*
|
|
1093
|
-
* ],
|
|
1094
|
-
* },
|
|
1095
|
-
* { key: "Category", value: "OST_Stairs" },
|
|
1096
|
-
* ],
|
|
1097
|
-
* };
|
|
1098
|
-
* ```
|
|
1072
|
+
* Returns the list of original handles for an objects in the file that match the specified
|
|
1073
|
+
* patterns. Search patterns may be combined using query operators.
|
|
1074
|
+
*
|
|
1075
|
+
* @example <caption>Simple search pattern.</caption>
|
|
1076
|
+
* searchPattern = {
|
|
1077
|
+
* key: "Category",
|
|
1078
|
+
* value: "OST_Stairs",
|
|
1079
|
+
* };
|
|
1080
|
+
*
|
|
1081
|
+
* @example <caption>Search patterns combination.</caption>
|
|
1082
|
+
* searchPattern = {
|
|
1083
|
+
* $or: [
|
|
1084
|
+
* {
|
|
1085
|
+
* $and: [
|
|
1086
|
+
* { key: "Category", value: "OST_GenericModel" },
|
|
1087
|
+
* { key: "Level", value: "03 - Floor" },
|
|
1088
|
+
* ],
|
|
1089
|
+
* },
|
|
1090
|
+
* { key: "Category", value: "OST_Stairs" },
|
|
1091
|
+
* ],
|
|
1092
|
+
* };
|
|
1099
1093
|
*
|
|
1100
1094
|
* @param searchPattern - Search pattern or combination of the patterns, see example below.
|
|
1101
1095
|
*/
|
|
@@ -1155,14 +1149,14 @@
|
|
|
1155
1149
|
return this.get(`/viewpoints/${guid}/bitmaps/${bitmapGuid}`).then((response) => response.text());
|
|
1156
1150
|
}
|
|
1157
1151
|
/**
|
|
1158
|
-
* Downloads an assembly resource file. Resource files are files that contain model scene
|
|
1159
|
-
* or geometry data.
|
|
1152
|
+
* Downloads an assembly resource file. Resource files are files that contain model scene
|
|
1153
|
+
* descriptions, or geometry data.
|
|
1160
1154
|
*
|
|
1161
1155
|
* @param dataId - Resource file name.
|
|
1162
1156
|
* @param onProgress - Download progress callback.
|
|
1163
1157
|
* @param signal - An
|
|
1164
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
1165
|
-
* to communicate with a fetch request and abort it if desired.
|
|
1158
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
1159
|
+
* signal. Allows to communicate with a fetch request and abort it if desired.
|
|
1166
1160
|
*/
|
|
1167
1161
|
downloadResource(dataId, onProgress, signal) {
|
|
1168
1162
|
return this.httpClient
|
|
@@ -1170,16 +1164,16 @@
|
|
|
1170
1164
|
.then((response) => response.arrayBuffer());
|
|
1171
1165
|
}
|
|
1172
1166
|
/**
|
|
1173
|
-
* Downloads a part of assembly resource file. Resource files are files that contain model
|
|
1174
|
-
* descriptions, or geometry data.
|
|
1167
|
+
* Downloads a part of assembly resource file. Resource files are files that contain model
|
|
1168
|
+
* scene descriptions, or geometry data.
|
|
1175
1169
|
*
|
|
1176
1170
|
* @param dataId - Resource file name.
|
|
1177
1171
|
* @param ranges - A range of resource file contents to download.
|
|
1178
1172
|
* @param requestId - Request ID for download progress callback.
|
|
1179
1173
|
* @param onProgress - Download progress callback.
|
|
1180
1174
|
* @param signal - An
|
|
1181
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
1182
|
-
* to communicate with a fetch request and abort it if desired.
|
|
1175
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
1176
|
+
* signal. Allows to communicate with a fetch request and abort it if desired.
|
|
1183
1177
|
*/
|
|
1184
1178
|
downloadResourceRange(dataId, requestId, ranges, onProgress, signal) {
|
|
1185
1179
|
return this.httpClient
|
|
@@ -1202,14 +1196,14 @@
|
|
|
1202
1196
|
await this.downloadResourceRange(dataId, requestId, records, onProgress, signal);
|
|
1203
1197
|
}
|
|
1204
1198
|
/**
|
|
1205
|
-
* Returns a list of assembly references containing references from all the files from which
|
|
1206
|
-
* assembly was created.
|
|
1199
|
+
* Returns a list of assembly references containing references from all the files from which
|
|
1200
|
+
* the assembly was created.
|
|
1207
1201
|
*
|
|
1208
1202
|
* References are images, fonts, or any other files to correct rendering of the assembly.
|
|
1209
1203
|
*
|
|
1210
1204
|
* @param signal - An
|
|
1211
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
1212
|
-
* can be used to abort waiting as desired.
|
|
1205
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
1206
|
+
* signal, which can be used to abort waiting as desired.
|
|
1213
1207
|
*/
|
|
1214
1208
|
async getReferences(signal) {
|
|
1215
1209
|
const files = new Endpoint("/files", this.httpClient, this.headers);
|
|
@@ -1225,20 +1219,20 @@
|
|
|
1225
1219
|
* Waits for assembly to be created. Assembly is created when it changes to `done` or `failed` status.
|
|
1226
1220
|
*
|
|
1227
1221
|
* @param params - An object containing waiting parameters.
|
|
1228
|
-
* @param params.timeout - The time, in milliseconds that the function should wait assembly.
|
|
1229
|
-
* assembly is not created during this time, the `TimeoutError` exception will be thrown.
|
|
1230
|
-
* @param params.interval - The time, in milliseconds, the function should delay in between
|
|
1231
|
-
* assembly status.
|
|
1222
|
+
* @param params.timeout - The time, in milliseconds that the function should wait assembly.
|
|
1223
|
+
* If assembly is not created during this time, the `TimeoutError` exception will be thrown.
|
|
1224
|
+
* @param params.interval - The time, in milliseconds, the function should delay in between
|
|
1225
|
+
* checking assembly status.
|
|
1232
1226
|
* @param params.signal - An
|
|
1233
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
1234
|
-
* can be used to abort waiting as desired.
|
|
1227
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
1228
|
+
* signal, which can be used to abort waiting as desired.
|
|
1235
1229
|
* @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
|
|
1236
1230
|
*/
|
|
1237
1231
|
waitForDone(params) {
|
|
1238
1232
|
const checkDone = () => this.checkout().then((assembly) => {
|
|
1239
1233
|
var _a;
|
|
1240
1234
|
const ready = ["done", "failed"].includes(assembly.status);
|
|
1241
|
-
const cancel = (_a = params === null || params ===
|
|
1235
|
+
const cancel = (_a = params === null || params === void 0 ? void 0 : params.onCheckout) === null || _a === void 0 ? void 0 : _a.call(params, assembly, ready);
|
|
1242
1236
|
return cancel || ready;
|
|
1243
1237
|
});
|
|
1244
1238
|
return waitFor(checkDone, params).then(() => this);
|
|
@@ -1250,8 +1244,8 @@
|
|
|
1250
1244
|
* @param limit - The maximum number of tests that should be returned per request. Used for paging.
|
|
1251
1245
|
* @param name - Filter the tests by part of the name. Case sensitive.
|
|
1252
1246
|
* @param ids - List of tests IDs to return.
|
|
1253
|
-
* @param sortByDesc - Allows to specify the descending order of the result. By default tests
|
|
1254
|
-
* sorted by name in ascending order.
|
|
1247
|
+
* @param sortByDesc - Allows to specify the descending order of the result. By default tests
|
|
1248
|
+
* are sorted by name in ascending order.
|
|
1255
1249
|
* @param sortField - Allows to specify sort field.
|
|
1256
1250
|
*/
|
|
1257
1251
|
getClashTests(start, limit, name, ids, sortByDesc, sortField) {
|
|
@@ -1314,31 +1308,33 @@
|
|
|
1314
1308
|
* - `models` - All objects of the models with original handles specified in the `selectionSetB`.
|
|
1315
1309
|
* - `searchquery` - Objects retrieved by the search queries specified in `selectionSetB`.
|
|
1316
1310
|
*
|
|
1317
|
-
* @param selectionSetA - First selection set for clash detection. Objects from
|
|
1318
|
-
* tested against each others by objects from the `selectionSetB`
|
|
1319
|
-
*
|
|
1320
|
-
*
|
|
1311
|
+
* @param selectionSetA - First selection set for clash detection. Objects from
|
|
1312
|
+
* `selectionSetA` will be tested against each others by objects from the `selectionSetB`
|
|
1313
|
+
* during the test.
|
|
1314
|
+
* @param selectionSetB - Second selection set for clash detection. Objects from
|
|
1315
|
+
* `selectionSetB` will be tested against each others by objects from the `selectionSetA`
|
|
1316
|
+
* during the test.
|
|
1321
1317
|
* @param params - An object containing test parameters.
|
|
1322
|
-
* @param params.tolerance - The distance of separation between objects at which test begins
|
|
1323
|
-
* clashes.
|
|
1318
|
+
* @param params.tolerance - The distance of separation between objects at which test begins
|
|
1319
|
+
* detecting clashes.
|
|
1324
1320
|
* @param params.clearance - The type of the clashes that the test detects:
|
|
1325
1321
|
*
|
|
1326
|
-
* - `true` - Сlearance clash. A clash in which the object A may or may not intersect with
|
|
1327
|
-
* comes within a distance of less than the `tolerance`.
|
|
1328
|
-
* - `false` - Hard clash. A clash in which the object A intersects with object B by a distance
|
|
1329
|
-
* than the `tolerance`.
|
|
1322
|
+
* - `true` - Сlearance clash. A clash in which the object A may or may not intersect with
|
|
1323
|
+
* object B, but comes within a distance of less than the `tolerance`.
|
|
1324
|
+
* - `false` - Hard clash. A clash in which the object A intersects with object B by a distance
|
|
1325
|
+
* of more than the `tolerance`.
|
|
1330
1326
|
*
|
|
1331
1327
|
* @param params.waitForDone - Wait for test to complete.
|
|
1332
|
-
* @param params.timeout - The time, in milliseconds that the function should wait test. If
|
|
1333
|
-
* complete during this time, the `TimeoutError` exception will be thrown.
|
|
1334
|
-
* @param params.interval - The time, in milliseconds, the function should delay in between
|
|
1335
|
-
* test status.
|
|
1328
|
+
* @param params.timeout - The time, in milliseconds that the function should wait test. If
|
|
1329
|
+
* test is not complete during this time, the `TimeoutError` exception will be thrown.
|
|
1330
|
+
* @param params.interval - The time, in milliseconds, the function should delay in between
|
|
1331
|
+
* checking test status.
|
|
1336
1332
|
* @param params.signal - An
|
|
1337
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
1338
|
-
* can be used to abort waiting as desired.
|
|
1333
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
1334
|
+
* signal, which can be used to abort waiting as desired.
|
|
1339
1335
|
*/
|
|
1340
1336
|
createClashTest(name, selectionTypeA, selectionTypeB, selectionSetA, selectionSetB, params) {
|
|
1341
|
-
const { tolerance, clearance, waitForDone } = params !== null && params !==
|
|
1337
|
+
const { tolerance, clearance, waitForDone } = params !== null && params !== void 0 ? params : {};
|
|
1342
1338
|
if (!Array.isArray(selectionSetA))
|
|
1343
1339
|
selectionSetA = [selectionSetA];
|
|
1344
1340
|
if (!Array.isArray(selectionSetB))
|
|
@@ -1385,13 +1381,13 @@
|
|
|
1385
1381
|
return this.update({ activeVersion: version });
|
|
1386
1382
|
}
|
|
1387
1383
|
// Reserved for future use
|
|
1388
|
-
createSharedLink(permissions) {
|
|
1384
|
+
async createSharedLink(permissions) {
|
|
1389
1385
|
return Promise.reject(new Error("Assembly shared link will be implemeted in a future release"));
|
|
1390
1386
|
}
|
|
1391
|
-
getSharedLink() {
|
|
1387
|
+
async getSharedLink() {
|
|
1392
1388
|
return Promise.resolve(undefined);
|
|
1393
1389
|
}
|
|
1394
|
-
deleteSharedLink() {
|
|
1390
|
+
async deleteSharedLink() {
|
|
1395
1391
|
return Promise.reject(new FetchError(404));
|
|
1396
1392
|
}
|
|
1397
1393
|
}
|
|
@@ -1750,8 +1746,8 @@
|
|
|
1750
1746
|
// acknowledge and accept the above terms.
|
|
1751
1747
|
///////////////////////////////////////////////////////////////////////////////
|
|
1752
1748
|
/**
|
|
1753
|
-
* Provides properties and methods for obtaining information about {@link File | file} actions
|
|
1754
|
-
* a specific user, project, or group.
|
|
1749
|
+
* Provides properties and methods for obtaining information about {@link File | file} actions
|
|
1750
|
+
* granted to a specific user, project, or group.
|
|
1755
1751
|
*/
|
|
1756
1752
|
class Permission extends Endpoint {
|
|
1757
1753
|
/**
|
|
@@ -1773,22 +1769,19 @@
|
|
|
1773
1769
|
* - `readViewpoint` - The ability to read file viewpoints.
|
|
1774
1770
|
* - `createViewpoint` - The ability to create file viewpoints.
|
|
1775
1771
|
*
|
|
1776
|
-
* @example Change file permissions for the the specified project
|
|
1777
|
-
*
|
|
1778
|
-
*
|
|
1779
|
-
*
|
|
1780
|
-
*
|
|
1781
|
-
*
|
|
1782
|
-
*
|
|
1783
|
-
*
|
|
1784
|
-
*
|
|
1785
|
-
*
|
|
1786
|
-
*
|
|
1787
|
-
*
|
|
1788
|
-
*
|
|
1789
|
-
* })
|
|
1790
|
-
* );
|
|
1791
|
-
* ```
|
|
1772
|
+
* @example <caption>Change file permissions for the the specified project.</caption>
|
|
1773
|
+
* const myFile = client.getFile(myFileId);
|
|
1774
|
+
* const permissions = await myFile.getPermissions();
|
|
1775
|
+
* const projectPermissions = permissions.filter((permission) =>
|
|
1776
|
+
* permission.grantedTo.some((x) => x.project?.id === myProjectId)
|
|
1777
|
+
* );
|
|
1778
|
+
* const newActions = ["read", "readSourceFile", "update"];
|
|
1779
|
+
* await Promise.all(
|
|
1780
|
+
* projectPermissions.map((permission) => {
|
|
1781
|
+
* permission.actions = newActions;
|
|
1782
|
+
* return permission.save();
|
|
1783
|
+
* })
|
|
1784
|
+
* );
|
|
1792
1785
|
*/
|
|
1793
1786
|
get actions() {
|
|
1794
1787
|
return this.data.actions;
|
|
@@ -1863,8 +1856,8 @@
|
|
|
1863
1856
|
return super.delete("").then((response) => response.json());
|
|
1864
1857
|
}
|
|
1865
1858
|
/**
|
|
1866
|
-
* Saves permission properties changes to the server. Call this method to update permission
|
|
1867
|
-
* server after any property changes.
|
|
1859
|
+
* Saves permission properties changes to the server. Call this method to update permission
|
|
1860
|
+
* data on the server after any property changes.
|
|
1868
1861
|
*/
|
|
1869
1862
|
save() {
|
|
1870
1863
|
return this.update(this.data);
|
|
@@ -1977,8 +1970,8 @@
|
|
|
1977
1970
|
return this.data.lastUpdate;
|
|
1978
1971
|
}
|
|
1979
1972
|
/**
|
|
1980
|
-
* Job type. Can be `properties`, `geomerty`, `geomertyGltf`, `validation`, `clash`, `dwg`,
|
|
1981
|
-
* `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` or custom job name.
|
|
1973
|
+
* Job type. Can be `properties`, `geomerty`, `geomertyGltf`, `validation`, `clash`, `dwg`,
|
|
1974
|
+
* `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` or custom job name.
|
|
1982
1975
|
*
|
|
1983
1976
|
* @readonly
|
|
1984
1977
|
*/
|
|
@@ -2030,8 +2023,8 @@
|
|
|
2030
2023
|
/**
|
|
2031
2024
|
* Updates job data on the server.
|
|
2032
2025
|
*
|
|
2033
|
-
* Only administrators can update job data. If the current logged in user is not an
|
|
2034
|
-
* exception will be thrown.
|
|
2026
|
+
* Only administrators can update job data. If the current logged in user is not an
|
|
2027
|
+
* administrator, an exception will be thrown.
|
|
2035
2028
|
*
|
|
2036
2029
|
* @param data - Raw job data. For more information, see
|
|
2037
2030
|
* {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
|
|
@@ -2042,8 +2035,8 @@
|
|
|
2042
2035
|
return this;
|
|
2043
2036
|
}
|
|
2044
2037
|
/**
|
|
2045
|
-
* Deletes a job from the server job list. Jobs that are in progress or have already been
|
|
2046
|
-
* cannot be deleted.
|
|
2038
|
+
* Deletes a job from the server job list. Jobs that are in progress or have already been
|
|
2039
|
+
* completed cannot be deleted.
|
|
2047
2040
|
*
|
|
2048
2041
|
* @returns Returns the raw data of a deleted job. For more information, see
|
|
2049
2042
|
* {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
|
|
@@ -2062,20 +2055,20 @@
|
|
|
2062
2055
|
* Waits for job to be done. Job is done when it changes to `done` or `failed` status.
|
|
2063
2056
|
*
|
|
2064
2057
|
* @param params - An object containing waiting parameters.
|
|
2065
|
-
* @param params.timeout - The time, in milliseconds that the function should wait job. If
|
|
2066
|
-
* done during this time, the `TimeoutError` exception will be thrown.
|
|
2067
|
-
* @param params.interval - The time, in milliseconds, the function should delay in between
|
|
2068
|
-
* job status.
|
|
2058
|
+
* @param params.timeout - The time, in milliseconds that the function should wait job. If
|
|
2059
|
+
* jobs is not done during this time, the `TimeoutError` exception will be thrown.
|
|
2060
|
+
* @param params.interval - The time, in milliseconds, the function should delay in between
|
|
2061
|
+
* checking job status.
|
|
2069
2062
|
* @param params.signal - An
|
|
2070
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
2071
|
-
* can be used to abort waiting as desired.
|
|
2063
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
2064
|
+
* signal, which can be used to abort waiting as desired.
|
|
2072
2065
|
* @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
|
|
2073
2066
|
*/
|
|
2074
2067
|
waitForDone(params) {
|
|
2075
2068
|
const checkDone = () => this.checkout().then((job) => {
|
|
2076
2069
|
var _a;
|
|
2077
2070
|
const ready = ["done", "failed"].includes(job.status);
|
|
2078
|
-
const cancel = (_a = params === null || params ===
|
|
2071
|
+
const cancel = (_a = params === null || params === void 0 ? void 0 : params.onCheckout) === null || _a === void 0 ? void 0 : _a.call(params, job, ready);
|
|
2079
2072
|
return cancel || ready;
|
|
2080
2073
|
});
|
|
2081
2074
|
return waitFor(checkDone, params).then(() => this);
|
|
@@ -2192,8 +2185,8 @@
|
|
|
2192
2185
|
return super.delete("").then((response) => response.json());
|
|
2193
2186
|
}
|
|
2194
2187
|
/**
|
|
2195
|
-
* Saves shared link properties changes to the server. Call this method to update shared link
|
|
2196
|
-
* the server after any property changes.
|
|
2188
|
+
* Saves shared link properties changes to the server. Call this method to update shared link
|
|
2189
|
+
* data on the server after any property changes.
|
|
2197
2190
|
*/
|
|
2198
2191
|
save() {
|
|
2199
2192
|
return this.update(this.data);
|
|
@@ -2223,8 +2216,8 @@
|
|
|
2223
2216
|
// acknowledge and accept the above terms.
|
|
2224
2217
|
///////////////////////////////////////////////////////////////////////////////
|
|
2225
2218
|
/**
|
|
2226
|
-
* Provides properties and methods for obtaining information about a file on the Open Cloud
|
|
2227
|
-
* managing its data and versions.
|
|
2219
|
+
* Provides properties and methods for obtaining information about a file on the Open Cloud
|
|
2220
|
+
* Server and managing its data and versions.
|
|
2228
2221
|
*/
|
|
2229
2222
|
class File extends Endpoint {
|
|
2230
2223
|
/**
|
|
@@ -2281,28 +2274,28 @@
|
|
|
2281
2274
|
// owner since 24.8
|
|
2282
2275
|
if (typeof this._data.owner === "string")
|
|
2283
2276
|
this._data.owner = { userId: this._data.owner };
|
|
2284
|
-
(_a = (_p = this._data).owner) !== null && _a !==
|
|
2277
|
+
(_a = (_p = this._data).owner) !== null && _a !== void 0 ? _a : (_p.owner = {});
|
|
2285
2278
|
this._data.owner.avatarUrl = `${this.httpClient.serverUrl}/users/${this._data.owner.userId}/avatar`;
|
|
2286
2279
|
this._data.owner.fullName = userFullName(this._data.owner);
|
|
2287
2280
|
this._data.owner.initials = userInitials(this._data.owner.fullName);
|
|
2288
2281
|
// status since 24.9
|
|
2289
|
-
(_b = (_q = this._data).status) !== null && _b !==
|
|
2290
|
-
(_c = (_r = this._data.status).geometry) !== null && _c !==
|
|
2291
|
-
(_e = (_s = this._data.status).properties) !== null && _e !==
|
|
2292
|
-
(_g = (_t = this._data.status).validation) !== null && _g !==
|
|
2282
|
+
(_b = (_q = this._data).status) !== null && _b !== void 0 ? _b : (_q.status = {});
|
|
2283
|
+
(_c = (_r = this._data.status).geometry) !== null && _c !== void 0 ? _c : (_r.geometry = { state: (_d = this._data.geometryStatus) !== null && _d !== void 0 ? _d : "none" });
|
|
2284
|
+
(_e = (_s = this._data.status).properties) !== null && _e !== void 0 ? _e : (_s.properties = { state: (_f = this._data.propertiesStatus) !== null && _f !== void 0 ? _f : "none" });
|
|
2285
|
+
(_g = (_t = this._data.status).validation) !== null && _g !== void 0 ? _g : (_t.validation = { state: (_h = this._data.validationStatus) !== null && _h !== void 0 ? _h : "none" });
|
|
2293
2286
|
// updatedBy since 24.10
|
|
2294
|
-
(_j = (_u = this._data).updatedBy) !== null && _j !==
|
|
2287
|
+
(_j = (_u = this._data).updatedBy) !== null && _j !== void 0 ? _j : (_u.updatedBy = {});
|
|
2295
2288
|
this._data.updatedBy.avatarUrl = `${this.httpClient.serverUrl}/users/${this._data.updatedBy.userId}/avatar`;
|
|
2296
2289
|
this._data.updatedBy.fullName = userFullName(this._data.updatedBy);
|
|
2297
2290
|
this._data.updatedBy.initials = userInitials(this._data.updatedBy.fullName);
|
|
2298
2291
|
// versions since 24.10
|
|
2299
|
-
(_k = (_v = this._data).versions) !== null && _k !==
|
|
2292
|
+
(_k = (_v = this._data).versions) !== null && _k !== void 0 ? _k : (_v.versions = [{ ...value }]);
|
|
2300
2293
|
// geometryGltf status since 24.12
|
|
2301
|
-
(_l = (_w = this._data.status).geometryGltf) !== null && _l !==
|
|
2294
|
+
(_l = (_w = this._data.status).geometryGltf) !== null && _l !== void 0 ? _l : (_w.geometryGltf = { state: "none" });
|
|
2302
2295
|
// isFileDeleted since 25.7
|
|
2303
|
-
(_m = (_x = this._data).isFileDeleted) !== null && _m !==
|
|
2296
|
+
(_m = (_x = this._data).isFileDeleted) !== null && _m !== void 0 ? _m : (_x.isFileDeleted = false);
|
|
2304
2297
|
// sharedLinkToken since 26.0
|
|
2305
|
-
(_o = (_y = this._data).sharedLinkToken) !== null && _o !==
|
|
2298
|
+
(_o = (_y = this._data).sharedLinkToken) !== null && _o !== void 0 ? _o : (_y.sharedLinkToken = null);
|
|
2306
2299
|
}
|
|
2307
2300
|
/**
|
|
2308
2301
|
* Returns a list of file formats in which the active version of the file was exported.
|
|
@@ -2324,8 +2317,8 @@
|
|
|
2324
2317
|
* - `vsfx` - `VSFX` format, file can be opened in `VisualizeJS` viewer.
|
|
2325
2318
|
* - `gltf` - `glTF` format, file can be opened in `Three.js` viewer.
|
|
2326
2319
|
*
|
|
2327
|
-
* Returns an empty string if geometry data has not yet been converted. A files without
|
|
2328
|
-
* can be exported to other formas, but cannot be opened in viewer.
|
|
2320
|
+
* Returns an empty string if geometry data has not yet been converted. A files without
|
|
2321
|
+
* geometry data can be exported to other formas, but cannot be opened in viewer.
|
|
2329
2322
|
*/
|
|
2330
2323
|
get geometryType() {
|
|
2331
2324
|
if (this.status.geometryGltf.state === "done")
|
|
@@ -2346,8 +2339,8 @@
|
|
|
2346
2339
|
/**
|
|
2347
2340
|
* Returns `true` if the source file of the active file version has been deleted.
|
|
2348
2341
|
*
|
|
2349
|
-
* A files with deleted source file can be opened in the viewer, but cannot be exported to
|
|
2350
|
-
* formats.
|
|
2342
|
+
* A files with deleted source file can be opened in the viewer, but cannot be exported to
|
|
2343
|
+
* other formats.
|
|
2351
2344
|
*
|
|
2352
2345
|
* @readonly
|
|
2353
2346
|
*/
|
|
@@ -2491,8 +2484,8 @@
|
|
|
2491
2484
|
/**
|
|
2492
2485
|
* Deletes a file and all its versions from the server.
|
|
2493
2486
|
*
|
|
2494
|
-
* You cannot delete a version file using `delete()`, only the original file. To delete a
|
|
2495
|
-
* use {@link deleteVersion | deleteVersion()}.
|
|
2487
|
+
* You cannot delete a version file using `delete()`, only the original file. To delete a
|
|
2488
|
+
* version file use {@link deleteVersion | deleteVersion()}.
|
|
2496
2489
|
*
|
|
2497
2490
|
* @returns Returns the raw data of a deleted file. For more information, see
|
|
2498
2491
|
* {@link https://cloud.opendesign.com/docs//pages/server/api.html#Files | Open Cloud Files API}.
|
|
@@ -2501,8 +2494,8 @@
|
|
|
2501
2494
|
return super.delete("").then((response) => response.json());
|
|
2502
2495
|
}
|
|
2503
2496
|
/**
|
|
2504
|
-
* Saves file properties changes to the server. Call this method to update file data on the
|
|
2505
|
-
* after any property changes.
|
|
2497
|
+
* Saves file properties changes to the server. Call this method to update file data on the
|
|
2498
|
+
* server after any property changes.
|
|
2506
2499
|
*/
|
|
2507
2500
|
save() {
|
|
2508
2501
|
return this.update(this.data);
|
|
@@ -2511,11 +2504,12 @@
|
|
|
2511
2504
|
* Sets or removes the file preview.
|
|
2512
2505
|
*
|
|
2513
2506
|
* @param image - Preview image. Can be a
|
|
2514
|
-
* {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
|
|
2507
|
+
* {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
|
|
2508
|
+
* string,
|
|
2515
2509
|
* {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer},
|
|
2516
2510
|
* {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob} or
|
|
2517
|
-
* {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object. Setting
|
|
2518
|
-
* to `null` will remove the preview.
|
|
2511
|
+
* {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object. Setting
|
|
2512
|
+
* the `image` to `null` will remove the preview.
|
|
2519
2513
|
*/
|
|
2520
2514
|
async setPreview(image) {
|
|
2521
2515
|
if (!image) {
|
|
@@ -2561,8 +2555,8 @@
|
|
|
2561
2555
|
/**
|
|
2562
2556
|
* Returns the properties for an objects in the active version of the file.
|
|
2563
2557
|
*
|
|
2564
|
-
* @param handles - Object original handle or handles array. Specify `undefined` to get
|
|
2565
|
-
* all objects in the file.
|
|
2558
|
+
* @param handles - Object original handle or handles array. Specify `undefined` to get
|
|
2559
|
+
* properties for all objects in the file.
|
|
2566
2560
|
*/
|
|
2567
2561
|
getProperties(handles) {
|
|
2568
2562
|
const relativePath = handles !== undefined ? `/properties?handles=${handles}` : "/properties";
|
|
@@ -2579,40 +2573,34 @@
|
|
|
2579
2573
|
* Query operator. Operator name can be `$and`, `$or`, `$not`, `$eq`, `$regex`.
|
|
2580
2574
|
*
|
|
2581
2575
|
* @typedef {any} QueryOperator
|
|
2582
|
-
* @property {string | SearchPattern[] | QueryOperator[]} * - Array of the query values or
|
|
2583
|
-
* operator.
|
|
2584
|
-
*/
|
|
2585
|
-
/**
|
|
2586
|
-
* Returns the list of original handles for an objects in the active version of the file that
|
|
2587
|
-
* specified patterns. Search patterns may be combined using query operators.
|
|
2588
|
-
*
|
|
2589
|
-
* @example Simple search pattern
|
|
2590
|
-
*
|
|
2591
|
-
*
|
|
2592
|
-
*
|
|
2593
|
-
*
|
|
2594
|
-
*
|
|
2595
|
-
*
|
|
2596
|
-
*
|
|
2597
|
-
*
|
|
2598
|
-
*
|
|
2599
|
-
*
|
|
2600
|
-
*
|
|
2601
|
-
*
|
|
2602
|
-
*
|
|
2603
|
-
*
|
|
2604
|
-
*
|
|
2605
|
-
*
|
|
2606
|
-
*
|
|
2607
|
-
*
|
|
2608
|
-
*
|
|
2609
|
-
*
|
|
2610
|
-
* ],
|
|
2611
|
-
* };
|
|
2612
|
-
* ```
|
|
2613
|
-
*
|
|
2614
|
-
* @param {SeacrhPattern | QueryOperator} searchPattern - Search pattern or combination of the
|
|
2615
|
-
* patterns, see example below.
|
|
2576
|
+
* @property {string | SearchPattern[] | QueryOperator[]} * - Array of the query values or
|
|
2577
|
+
* patterns for operator.
|
|
2578
|
+
*/
|
|
2579
|
+
/**
|
|
2580
|
+
* Returns the list of original handles for an objects in the active version of the file that
|
|
2581
|
+
* match the specified patterns. Search patterns may be combined using query operators.
|
|
2582
|
+
*
|
|
2583
|
+
* @example <caption>Simple search pattern.</caption>
|
|
2584
|
+
* searchPattern = {
|
|
2585
|
+
* key: "Category",
|
|
2586
|
+
* value: "OST_Stairs",
|
|
2587
|
+
* };
|
|
2588
|
+
*
|
|
2589
|
+
* @example <caption>Search patterns combination.</caption>
|
|
2590
|
+
* searchPattern = {
|
|
2591
|
+
* $or: [
|
|
2592
|
+
* {
|
|
2593
|
+
* $and: [
|
|
2594
|
+
* { key: "Category", value: "OST_GenericModel" },
|
|
2595
|
+
* { key: "Level", value: "03 - Floor" },
|
|
2596
|
+
* ],
|
|
2597
|
+
* },
|
|
2598
|
+
* { key: "Category", value: "OST_Stairs" },
|
|
2599
|
+
* ],
|
|
2600
|
+
* };
|
|
2601
|
+
*
|
|
2602
|
+
* @param {SeacrhPattern | QueryOperator} searchPattern - Search pattern or combination of
|
|
2603
|
+
* the patterns, see example below.
|
|
2616
2604
|
* @returns {Promise<Properties[]>}
|
|
2617
2605
|
*/
|
|
2618
2606
|
searchProperties(searchPattern) {
|
|
@@ -2675,8 +2663,8 @@
|
|
|
2675
2663
|
*
|
|
2676
2664
|
* @param onProgress - Download progress callback.
|
|
2677
2665
|
* @param signal - An
|
|
2678
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
2679
|
-
* to communicate with a fetch request and abort it if desired.
|
|
2666
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
2667
|
+
* signal. Allows to communicate with a fetch request and abort it if desired.
|
|
2680
2668
|
*/
|
|
2681
2669
|
download(onProgress, signal) {
|
|
2682
2670
|
return this.httpClient
|
|
@@ -2684,26 +2672,23 @@
|
|
|
2684
2672
|
.then((response) => response.arrayBuffer());
|
|
2685
2673
|
}
|
|
2686
2674
|
/**
|
|
2687
|
-
* Downloads a resource file of the active version of the file. Resource files are files that
|
|
2688
|
-
* model scene descriptions, or geometry data, or exported files.
|
|
2689
|
-
*
|
|
2690
|
-
* @example Export file to DWG.
|
|
2675
|
+
* Downloads a resource file of the active version of the file. Resource files are files that
|
|
2676
|
+
* contain model scene descriptions, or geometry data, or exported files.
|
|
2691
2677
|
*
|
|
2692
|
-
*
|
|
2693
|
-
*
|
|
2694
|
-
*
|
|
2695
|
-
*
|
|
2696
|
-
*
|
|
2697
|
-
*
|
|
2698
|
-
*
|
|
2699
|
-
*
|
|
2700
|
-
* ```
|
|
2678
|
+
* @example <caption>Export file to DWG.</caption>
|
|
2679
|
+
* const job = await file.crateJob("dwg");
|
|
2680
|
+
* await job.waitForDone();
|
|
2681
|
+
* const dwgFileName = file.exports.find((x) => x.endsWith(".dwg"));
|
|
2682
|
+
* const arrayBuffer = await file.downloadResource(dwgFileName);
|
|
2683
|
+
* const blob = new Blob([arrayBuffer]);
|
|
2684
|
+
* const fileName = file.name + ".dwg";
|
|
2685
|
+
* FileSaver.saveAs(blob, fileName);
|
|
2701
2686
|
*
|
|
2702
2687
|
* @param dataId - Resource file name.
|
|
2703
2688
|
* @param onProgress - Download progress callback.
|
|
2704
2689
|
* @param signal - An
|
|
2705
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
2706
|
-
* to communicate with a fetch request and abort it if desired.
|
|
2690
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
2691
|
+
* signal. Allows to communicate with a fetch request and abort it if desired.
|
|
2707
2692
|
*/
|
|
2708
2693
|
downloadResource(dataId, onProgress, signal) {
|
|
2709
2694
|
return this.httpClient
|
|
@@ -2711,16 +2696,16 @@
|
|
|
2711
2696
|
.then((response) => response.arrayBuffer());
|
|
2712
2697
|
}
|
|
2713
2698
|
/**
|
|
2714
|
-
* Downloads a part of resource file of the active version of the file. Resource files are
|
|
2715
|
-
* contain model scene descriptions, or geometry data, or exported files.
|
|
2699
|
+
* Downloads a part of resource file of the active version of the file. Resource files are
|
|
2700
|
+
* files that contain model scene descriptions, or geometry data, or exported files.
|
|
2716
2701
|
*
|
|
2717
2702
|
* @param dataId - Resource file name.
|
|
2718
2703
|
* @param ranges - A range of resource file contents to download.
|
|
2719
2704
|
* @param requestId - Request ID for download progress callback.
|
|
2720
2705
|
* @param onProgress - Download progress callback.
|
|
2721
2706
|
* @param signal - An
|
|
2722
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
2723
|
-
* to communicate with a fetch request and abort it if desired.
|
|
2707
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
2708
|
+
* signal. Allows to communicate with a fetch request and abort it if desired.
|
|
2724
2709
|
*/
|
|
2725
2710
|
downloadResourceRange(dataId, requestId, ranges, onProgress, signal) {
|
|
2726
2711
|
return this.httpClient
|
|
@@ -2750,8 +2735,8 @@
|
|
|
2750
2735
|
* References are images, fonts, or any other files to correct rendering of the file.
|
|
2751
2736
|
*
|
|
2752
2737
|
* @param signal - An
|
|
2753
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
2754
|
-
* can be used to abort waiting as desired.
|
|
2738
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
2739
|
+
* signal, which can be used to abort waiting as desired.
|
|
2755
2740
|
*/
|
|
2756
2741
|
getReferences(signal) {
|
|
2757
2742
|
return this.get("/references", signal).then((response) => response.json());
|
|
@@ -2759,8 +2744,8 @@
|
|
|
2759
2744
|
/**
|
|
2760
2745
|
* Sets the file references.
|
|
2761
2746
|
*
|
|
2762
|
-
* References are images, fonts, or any other files to correct rendering of the file.
|
|
2763
|
-
* must be uploaded to the server before they can be assigned to the current file.
|
|
2747
|
+
* References are images, fonts, or any other files to correct rendering of the file.
|
|
2748
|
+
* Reference files must be uploaded to the server before they can be assigned to the current file.
|
|
2764
2749
|
*
|
|
2765
2750
|
* @param references - File references.
|
|
2766
2751
|
*/
|
|
@@ -2776,14 +2761,14 @@
|
|
|
2776
2761
|
* - `geometryGltf` - Convert file geometry data to `glTF` format suitable for `Three.js` viewer.
|
|
2777
2762
|
* - `properties` - Extract file properties.
|
|
2778
2763
|
* - `validation` - Validate the file. Only for `IFC` files.
|
|
2779
|
-
* - `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` - Export file to the one of the
|
|
2780
|
-
* Use {@link exports | exports()} to get the list of completed file
|
|
2781
|
-
* {@link downloadResource | downloadResource()} to download the exported file.
|
|
2782
|
-
* - Other custom job name. Custom job runner must be registered in the job templates before
|
|
2783
|
-
* job.
|
|
2764
|
+
* - `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` - Export file to the one of the
|
|
2765
|
+
* supported format. Use {@link exports | exports()} to get the list of completed file
|
|
2766
|
+
* exports. Use {@link downloadResource | downloadResource()} to download the exported file.
|
|
2767
|
+
* - Other custom job name. Custom job runner must be registered in the job templates before
|
|
2768
|
+
* creating a job.
|
|
2784
2769
|
*
|
|
2785
|
-
* @param parameters - Parameters for the job runner. Can be given as command line arguments
|
|
2786
|
-
* File Converter tool in form `--arg=value`.
|
|
2770
|
+
* @param parameters - Parameters for the job runner. Can be given as command line arguments
|
|
2771
|
+
* for the File Converter tool in form `--arg=value`.
|
|
2787
2772
|
*/
|
|
2788
2773
|
createJob(outputFormat, parameters) {
|
|
2789
2774
|
const jobs = new Endpoint("/jobs", this.httpClient, this.headers);
|
|
@@ -2805,8 +2790,8 @@
|
|
|
2805
2790
|
* - `vsfx` - `VSFX` format (default), for opening a file in `VisualizeJS` viewer.
|
|
2806
2791
|
* - `gltf` - `glTF` format, for opening a file in `Three.js` viewer.
|
|
2807
2792
|
*
|
|
2808
|
-
* @param parameters - Parameters for the job runner. Can be given as command line arguments
|
|
2809
|
-
* File Converter tool in form `--arg=value`.
|
|
2793
|
+
* @param parameters - Parameters for the job runner. Can be given as command line arguments
|
|
2794
|
+
* for the File Converter tool in form `--arg=value`.
|
|
2810
2795
|
*/
|
|
2811
2796
|
extractGeometry(type, parameters) {
|
|
2812
2797
|
return this.createJob(type === "gltf" ? "geometryGltf" : "geometry", parameters);
|
|
@@ -2815,8 +2800,8 @@
|
|
|
2815
2800
|
* Runs a job to extract properties of the active version of the file. This is alias to
|
|
2816
2801
|
* {@link createJob | createJob("properties")}.
|
|
2817
2802
|
*
|
|
2818
|
-
* @param parameters - Parameters for the job runner. Can be given as command line arguments
|
|
2819
|
-
* File Converter tool in form `--arg=value`.
|
|
2803
|
+
* @param parameters - Parameters for the job runner. Can be given as command line arguments
|
|
2804
|
+
* for the File Converter tool in form `--arg=value`.
|
|
2820
2805
|
*/
|
|
2821
2806
|
extractProperties(parameters) {
|
|
2822
2807
|
return this.createJob("properties", parameters);
|
|
@@ -2827,28 +2812,29 @@
|
|
|
2827
2812
|
*
|
|
2828
2813
|
* To get validation report use {@link downloadResource | downloadResource("validation_report.json")}.
|
|
2829
2814
|
*
|
|
2830
|
-
* @param parameters - Parameters for the job runner. Can be given as command line arguments
|
|
2831
|
-
* File Converter tool in form `--arg=value`.
|
|
2815
|
+
* @param parameters - Parameters for the job runner. Can be given as command line arguments
|
|
2816
|
+
* for the File Converter tool in form `--arg=value`.
|
|
2832
2817
|
*/
|
|
2833
2818
|
validate(parameters) {
|
|
2834
2819
|
return this.createJob("validation", parameters);
|
|
2835
2820
|
}
|
|
2836
2821
|
/**
|
|
2837
|
-
* Waits for jobs of the active version of the file to be done. Job is done when it changes
|
|
2838
|
-
* `done` or `failed` status.
|
|
2822
|
+
* Waits for jobs of the active version of the file to be done. Job is done when it changes
|
|
2823
|
+
* to `none`, `done` or `failed` status.
|
|
2839
2824
|
*
|
|
2840
|
-
* @param jobs - Job or job array to wait on. Can be `geometry`, `geometryGltf`,
|
|
2841
|
-
* `validation`, `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` or custom
|
|
2842
|
-
*
|
|
2843
|
-
*
|
|
2825
|
+
* @param jobs - Job or job array to wait on. Can be `geometry`, `geometryGltf`,
|
|
2826
|
+
* `properties`, `validation`, `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` or custom
|
|
2827
|
+
* job name.
|
|
2828
|
+
* @param waitAll - If this parameter is `true`, the function returns when all the specified
|
|
2829
|
+
* jobs have done. If `false`, the function returns when any one of the jobs are done.
|
|
2844
2830
|
* @param params - An object containing waiting parameters.
|
|
2845
|
-
* @param params.timeout - The time, in milliseconds that the function should wait jobs. If
|
|
2846
|
-
* are done during this time, the `TimeoutError` exception will be thrown.
|
|
2847
|
-
* @param params.interval - The time, in milliseconds, the function should delay in between
|
|
2848
|
-
* jobs status.
|
|
2831
|
+
* @param params.timeout - The time, in milliseconds that the function should wait jobs. If
|
|
2832
|
+
* no one jobs are done during this time, the `TimeoutError` exception will be thrown.
|
|
2833
|
+
* @param params.interval - The time, in milliseconds, the function should delay in between
|
|
2834
|
+
* checking jobs status.
|
|
2849
2835
|
* @param params.signal - An
|
|
2850
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
2851
|
-
* can be used to abort waiting as desired.
|
|
2836
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
2837
|
+
* signal, which can be used to abort waiting as desired.
|
|
2852
2838
|
* @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
|
|
2853
2839
|
*/
|
|
2854
2840
|
waitForDone(jobs, waitAll, params) {
|
|
@@ -2862,7 +2848,7 @@
|
|
|
2862
2848
|
return ["none", "done", "failed"].includes(jobStatus.state || "none");
|
|
2863
2849
|
});
|
|
2864
2850
|
const ready = waitAll ? readyJobs.length === waitJobs.length : readyJobs.length > 0;
|
|
2865
|
-
const cancel = (_a = params === null || params ===
|
|
2851
|
+
const cancel = (_a = params === null || params === void 0 ? void 0 : params.onCheckout) === null || _a === void 0 ? void 0 : _a.call(params, file, ready);
|
|
2866
2852
|
return cancel || ready;
|
|
2867
2853
|
});
|
|
2868
2854
|
return waitFor(checkDone, params).then(() => this);
|
|
@@ -2888,21 +2874,15 @@
|
|
|
2888
2874
|
/**
|
|
2889
2875
|
* Creates a new file permission for a user, project, or group.
|
|
2890
2876
|
*
|
|
2891
|
-
* @example Grant the specified user permission to "update" the file
|
|
2892
|
-
*
|
|
2893
|
-
*
|
|
2894
|
-
*
|
|
2895
|
-
* const grantedTo = [{ user: { id: myUser.id, email: myUser.email } }];
|
|
2896
|
-
* await file.createPermission(action, grantedTo);
|
|
2897
|
-
* ```
|
|
2877
|
+
* @example <caption>Grant the specified user permission to "update" the file.</caption>
|
|
2878
|
+
* const action = "update";
|
|
2879
|
+
* const grantedTo = [{ user: { id: myUser.id, email: myUser.email } }];
|
|
2880
|
+
* await file.createPermission(action, grantedTo);
|
|
2898
2881
|
*
|
|
2899
|
-
* @example Add a file to the specified project in
|
|
2900
|
-
*
|
|
2901
|
-
*
|
|
2902
|
-
*
|
|
2903
|
-
* const grantedTo = [{ project: { id: myProject.id, name: myProject.name } }];
|
|
2904
|
-
* await file.createPermission(actions, grantedTo);
|
|
2905
|
-
* ```
|
|
2882
|
+
* @example <caption>Add a file to the specified project in `read-only` mode.</caption>
|
|
2883
|
+
* const actions = ["read", "readSourceFile"];
|
|
2884
|
+
* const grantedTo = [{ project: { id: myProject.id, name: myProject.name } }];
|
|
2885
|
+
* await file.createPermission(actions, grantedTo);
|
|
2906
2886
|
*
|
|
2907
2887
|
* @param actions - Actions are allowed to be performed on a file with this permission:
|
|
2908
2888
|
*
|
|
@@ -2935,31 +2915,32 @@
|
|
|
2935
2915
|
return super.delete(`/permissions/${permissionId}`).then((response) => response.json());
|
|
2936
2916
|
}
|
|
2937
2917
|
/**
|
|
2938
|
-
* Uploads the new version of the file to the server, convert the geometry data and extract
|
|
2939
|
-
* as needed.
|
|
2918
|
+
* Uploads the new version of the file to the server, convert the geometry data and extract
|
|
2919
|
+
* properties as needed.
|
|
2940
2920
|
*
|
|
2941
|
-
* @param file - {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object
|
|
2942
|
-
* generally retrieved from a
|
|
2943
|
-
*
|
|
2921
|
+
* @param file - {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object
|
|
2922
|
+
* are generally retrieved from a
|
|
2923
|
+
* {@link https://developer.mozilla.org/docs/Web/API/FileList | FileList} object returned as
|
|
2924
|
+
* a result of a user selecting files using the HTML `<input>` element.
|
|
2944
2925
|
* @param params - An object containing upload parameters.
|
|
2945
|
-
* @param params.geometry - Create job to convert file geometry data. The geometry data type
|
|
2946
|
-
* same as the original file.
|
|
2926
|
+
* @param params.geometry - Create job to convert file geometry data. The geometry data type
|
|
2927
|
+
* is the same as the original file.
|
|
2947
2928
|
* @param params.properties - Create job to extract file properties.
|
|
2948
2929
|
* @param params.waitForDone - Wait for geometry and properties jobs to complete.
|
|
2949
|
-
* @param params.timeout - The time, in milliseconds that the function should wait jobs. If
|
|
2950
|
-
* are done during this time, the `TimeoutError` exception will be thrown.
|
|
2951
|
-
* @param params.interval - The time, in milliseconds, the function should delay in between
|
|
2952
|
-
* jobs status.
|
|
2930
|
+
* @param params.timeout - The time, in milliseconds that the function should wait jobs. If
|
|
2931
|
+
* no one jobs are done during this time, the `TimeoutError` exception will be thrown.
|
|
2932
|
+
* @param params.interval - The time, in milliseconds, the function should delay in between
|
|
2933
|
+
* checking jobs status.
|
|
2953
2934
|
* @param params.signal - An
|
|
2954
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
2955
|
-
* can be used to abort waiting as desired.
|
|
2935
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
2936
|
+
* signal, which can be used to abort waiting as desired.
|
|
2956
2937
|
* @param params.onProgress - Upload progress callback.
|
|
2957
2938
|
*/
|
|
2958
2939
|
async uploadVersion(file, params = {
|
|
2959
2940
|
waitForDone: false,
|
|
2960
2941
|
}) {
|
|
2961
2942
|
const result = await this.httpClient
|
|
2962
|
-
.uploadFile(this.getEndpointPath("/versions"), file, (progress) => { var _a; return (_a = params.onProgress) === null || _a ===
|
|
2943
|
+
.uploadFile(this.getEndpointPath("/versions"), file, (progress) => { var _a; return (_a = params.onProgress) === null || _a === void 0 ? void 0 : _a.call(params, progress, file); }, {
|
|
2963
2944
|
headers: this.headers,
|
|
2964
2945
|
})
|
|
2965
2946
|
.then((xhr) => JSON.parse(xhr.responseText))
|
|
@@ -3029,8 +3010,8 @@
|
|
|
3029
3010
|
return this.update({ activeVersion: version });
|
|
3030
3011
|
}
|
|
3031
3012
|
/**
|
|
3032
|
-
* Makes the given version active on client side. Does not change the active file version on
|
|
3033
|
-
* server.
|
|
3013
|
+
* Makes the given version active on client side. Does not change the active file version on
|
|
3014
|
+
* the server.
|
|
3034
3015
|
*
|
|
3035
3016
|
* This version change will affect the result:
|
|
3036
3017
|
*
|
|
@@ -3047,11 +3028,11 @@
|
|
|
3047
3028
|
* - {@link waitForDone | waitForDone()}
|
|
3048
3029
|
* - Viewer.open()
|
|
3049
3030
|
*
|
|
3050
|
-
* Other clients will still continue to use the current active version of the file. Use
|
|
3051
|
-
* revert back to the active version.
|
|
3031
|
+
* Other clients will still continue to use the current active version of the file. Use
|
|
3032
|
+
* `undefined` to revert back to the active version.
|
|
3052
3033
|
*
|
|
3053
|
-
* You need to reload the file data using {@link checkout | checkout()} to match the size and
|
|
3054
|
-
* fields to the version you selected.
|
|
3034
|
+
* You need to reload the file data using {@link checkout | checkout()} to match the size and
|
|
3035
|
+
* status fields to the version you selected.
|
|
3055
3036
|
*/
|
|
3056
3037
|
useVersion(version) {
|
|
3057
3038
|
return super.useVersion(version);
|
|
@@ -3209,8 +3190,8 @@
|
|
|
3209
3190
|
return super.delete("").then((response) => response.json());
|
|
3210
3191
|
}
|
|
3211
3192
|
/**
|
|
3212
|
-
* Saves role properties changes to the server. Call this method to update role data on the
|
|
3213
|
-
* after any property changes.
|
|
3193
|
+
* Saves role properties changes to the server. Call this method to update role data on the
|
|
3194
|
+
* server after any property changes.
|
|
3214
3195
|
*/
|
|
3215
3196
|
save() {
|
|
3216
3197
|
return this.update(this.data);
|
|
@@ -3240,8 +3221,8 @@
|
|
|
3240
3221
|
// acknowledge and accept the above terms.
|
|
3241
3222
|
///////////////////////////////////////////////////////////////////////////////
|
|
3242
3223
|
/**
|
|
3243
|
-
* Provides properties and methods for obtaining information about a {@link User | user} who has
|
|
3244
|
-
* the {@link Project | project}.
|
|
3224
|
+
* Provides properties and methods for obtaining information about a {@link User | user} who has
|
|
3225
|
+
* access to the {@link Project | project}.
|
|
3245
3226
|
*/
|
|
3246
3227
|
class Member extends Endpoint {
|
|
3247
3228
|
/**
|
|
@@ -3278,8 +3259,8 @@
|
|
|
3278
3259
|
return this.data.id;
|
|
3279
3260
|
}
|
|
3280
3261
|
/**
|
|
3281
|
-
* Member role name in the project. See {@link Project.getRoles | Project.getRoles()} for list
|
|
3282
|
-
* project roles.
|
|
3262
|
+
* Member role name in the project. See {@link Project.getRoles | Project.getRoles()} for list
|
|
3263
|
+
* of project roles.
|
|
3283
3264
|
*/
|
|
3284
3265
|
get role() {
|
|
3285
3266
|
return this.data.role;
|
|
@@ -3332,8 +3313,8 @@
|
|
|
3332
3313
|
return super.delete("").then((response) => response.json());
|
|
3333
3314
|
}
|
|
3334
3315
|
/**
|
|
3335
|
-
* Saves member properties changes to the server. Call this method to update member data on
|
|
3336
|
-
* after any property changes.
|
|
3316
|
+
* Saves member properties changes to the server. Call this method to update member data on
|
|
3317
|
+
* the server after any property changes.
|
|
3337
3318
|
*/
|
|
3338
3319
|
save() {
|
|
3339
3320
|
return this.update(this.data);
|
|
@@ -3363,8 +3344,8 @@
|
|
|
3363
3344
|
// acknowledge and accept the above terms.
|
|
3364
3345
|
///////////////////////////////////////////////////////////////////////////////
|
|
3365
3346
|
/**
|
|
3366
|
-
* Provides properties and methods for obtaining information about a project on the Open Cloud
|
|
3367
|
-
* managing its {@link Role | roles}, {@link Member | members} and models.
|
|
3347
|
+
* Provides properties and methods for obtaining information about a project on the Open Cloud
|
|
3348
|
+
* Server and managing its {@link Role | roles}, {@link Member | members} and models.
|
|
3368
3349
|
*/
|
|
3369
3350
|
class Project extends Endpoint {
|
|
3370
3351
|
/**
|
|
@@ -3565,8 +3546,8 @@
|
|
|
3565
3546
|
});
|
|
3566
3547
|
}
|
|
3567
3548
|
/**
|
|
3568
|
-
* Saves project properties changes to the server. Call this method to update project data on
|
|
3569
|
-
* server after any property changes.
|
|
3549
|
+
* Saves project properties changes to the server. Call this method to update project data on
|
|
3550
|
+
* the server after any property changes.
|
|
3570
3551
|
*/
|
|
3571
3552
|
save() {
|
|
3572
3553
|
return this.update(this.data);
|
|
@@ -3575,11 +3556,12 @@
|
|
|
3575
3556
|
* Sets or removes the project preview.
|
|
3576
3557
|
*
|
|
3577
3558
|
* @param image - Preview image. Can be a
|
|
3578
|
-
* {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
|
|
3559
|
+
* {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
|
|
3560
|
+
* string,
|
|
3579
3561
|
* {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer},
|
|
3580
3562
|
* {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob} or
|
|
3581
|
-
* {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object. Setting
|
|
3582
|
-
* to `null` will remove the preview.
|
|
3563
|
+
* {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object. Setting
|
|
3564
|
+
* the `image` to `null` will remove the preview.
|
|
3583
3565
|
*/
|
|
3584
3566
|
async setPreview(image) {
|
|
3585
3567
|
if (!image) {
|
|
@@ -3600,8 +3582,8 @@
|
|
|
3600
3582
|
return this;
|
|
3601
3583
|
}
|
|
3602
3584
|
/**
|
|
3603
|
-
* Returns a list of project roles. Project members have different abilities depending on the
|
|
3604
|
-
* have in a project.
|
|
3585
|
+
* Returns a list of project roles. Project members have different abilities depending on the
|
|
3586
|
+
* role they have in a project.
|
|
3605
3587
|
*/
|
|
3606
3588
|
getRoles() {
|
|
3607
3589
|
return this.get("/roles")
|
|
@@ -3687,8 +3669,8 @@
|
|
|
3687
3669
|
* Information about the file (model) that can be reference in the project topics.
|
|
3688
3670
|
*
|
|
3689
3671
|
* @typedef {any} FileInformation
|
|
3690
|
-
* @property {any[]} display_information - The list of fields to allow users to associate the
|
|
3691
|
-
* a server model.
|
|
3672
|
+
* @property {any[]} display_information - The list of fields to allow users to associate the
|
|
3673
|
+
* file with a server model.
|
|
3692
3674
|
* @property {string} display_information.field_display_name - Field display name.
|
|
3693
3675
|
* @property {string} display_information.field_value - Field value.
|
|
3694
3676
|
* @property {any} file - The file reference object.
|
|
@@ -3699,8 +3681,8 @@
|
|
|
3699
3681
|
* Returns a list of project files. For more information, see
|
|
3700
3682
|
* {@link https://cloud.opendesign.com/docs//pages/server/bcf3.html#ProjectFilesInformation | Open Cloud BCF3 API}.
|
|
3701
3683
|
*
|
|
3702
|
-
* This list contains all files that the project has access to. To add a file to this list,
|
|
3703
|
-
* {@link IGrantedTo.project | project} permission on the file using
|
|
3684
|
+
* This list contains all files that the project has access to. To add a file to this list,
|
|
3685
|
+
* create a {@link IGrantedTo.project | project} permission on the file using
|
|
3704
3686
|
* {@link File.createPermission | File.createPermission()}.
|
|
3705
3687
|
*/
|
|
3706
3688
|
getFilesInformation() {
|
|
@@ -3800,7 +3782,7 @@
|
|
|
3800
3782
|
.then((data) => new File(data, this.httpClient));
|
|
3801
3783
|
const permissions = await file.getPermissions();
|
|
3802
3784
|
await Promise.allSettled(permissions
|
|
3803
|
-
.filter((permission) => permission.grantedTo.some((x) => { var _a; return ((_a = x.project) === null || _a ===
|
|
3785
|
+
.filter((permission) => permission.grantedTo.some((x) => { var _a; return ((_a = x.project) === null || _a === void 0 ? void 0 : _a.id) === this.id; }))
|
|
3804
3786
|
.map((permission) => permission.delete()));
|
|
3805
3787
|
return file;
|
|
3806
3788
|
}
|
|
@@ -3829,8 +3811,8 @@
|
|
|
3829
3811
|
// acknowledge and accept the above terms.
|
|
3830
3812
|
///////////////////////////////////////////////////////////////////////////////
|
|
3831
3813
|
/**
|
|
3832
|
-
* Provides properties and methods for obtaining information about a Open Cloud Server user and
|
|
3833
|
-
* its data.
|
|
3814
|
+
* Provides properties and methods for obtaining information about a Open Cloud Server user and
|
|
3815
|
+
* manage its data.
|
|
3834
3816
|
*/
|
|
3835
3817
|
class User extends Endpoint {
|
|
3836
3818
|
/**
|
|
@@ -3927,8 +3909,8 @@
|
|
|
3927
3909
|
this._data.firstName = value;
|
|
3928
3910
|
}
|
|
3929
3911
|
/**
|
|
3930
|
-
* Full name. Returns the user's first and last name. If first name and last names are empty,
|
|
3931
|
-
* the user name.
|
|
3912
|
+
* Full name. Returns the user's first and last name. If first name and last names are empty,
|
|
3913
|
+
* returns the user name.
|
|
3932
3914
|
*
|
|
3933
3915
|
* @readonly
|
|
3934
3916
|
*/
|
|
@@ -3944,8 +3926,8 @@
|
|
|
3944
3926
|
return this.data.id;
|
|
3945
3927
|
}
|
|
3946
3928
|
/**
|
|
3947
|
-
* User initials. Returns a first letters of the user's first and last names. If first name
|
|
3948
|
-
* names are empty, returns the first letter of the user name.
|
|
3929
|
+
* User initials. Returns a first letters of the user's first and last names. If first name
|
|
3930
|
+
* and last names are empty, returns the first letter of the user name.
|
|
3949
3931
|
*
|
|
3950
3932
|
* @readonly
|
|
3951
3933
|
*/
|
|
@@ -4006,8 +3988,8 @@
|
|
|
4006
3988
|
this._data.projectsLimit = value;
|
|
4007
3989
|
}
|
|
4008
3990
|
/**
|
|
4009
|
-
* The identity provider used to create the account. Can be `ldap`, `oauth`, `saml` or empty
|
|
4010
|
-
* accounts.
|
|
3991
|
+
* The identity provider used to create the account. Can be `ldap`, `oauth`, `saml` or empty
|
|
3992
|
+
* for local accounts.
|
|
4011
3993
|
*
|
|
4012
3994
|
* @readonly
|
|
4013
3995
|
*/
|
|
@@ -4034,8 +4016,8 @@
|
|
|
4034
4016
|
return this.data.storageUsed;
|
|
4035
4017
|
}
|
|
4036
4018
|
/**
|
|
4037
|
-
* The user's access token (API key). Use
|
|
4038
|
-
* sign in to the server using this token.
|
|
4019
|
+
* The user's access token (API key). Use
|
|
4020
|
+
* {@link Client.signInWithToken | Client.signInWithToken()} to sign in to the server using this token.
|
|
4039
4021
|
*
|
|
4040
4022
|
* @readonly
|
|
4041
4023
|
*/
|
|
@@ -4054,8 +4036,8 @@
|
|
|
4054
4036
|
/**
|
|
4055
4037
|
* Reloads user data from the server.
|
|
4056
4038
|
*
|
|
4057
|
-
* Only administrators can checkout other users. If the current logged in user is not an
|
|
4058
|
-
* they can only checkout themselves, otherwise an exception will be thrown.
|
|
4039
|
+
* Only administrators can checkout other users. If the current logged in user is not an
|
|
4040
|
+
* administrator, they can only checkout themselves, otherwise an exception will be thrown.
|
|
4059
4041
|
*/
|
|
4060
4042
|
async checkout() {
|
|
4061
4043
|
if (this.httpClient.signInUserIsAdmin) {
|
|
@@ -4076,8 +4058,8 @@
|
|
|
4076
4058
|
/**
|
|
4077
4059
|
* Updates user data on the server.
|
|
4078
4060
|
*
|
|
4079
|
-
* Only administrators can update other users. If the current logged in user is not an
|
|
4080
|
-
* they can only update themself, otherwise an exception will be thrown.
|
|
4061
|
+
* Only administrators can update other users. If the current logged in user is not an
|
|
4062
|
+
* administrator, they can only update themself, otherwise an exception will be thrown.
|
|
4081
4063
|
*
|
|
4082
4064
|
* @param data - Raw user data. For more information, see
|
|
4083
4065
|
* {@link https://cloud.opendesign.com/docs//pages/server/api.html#Users | Open Cloud Users API}.
|
|
@@ -4101,11 +4083,11 @@
|
|
|
4101
4083
|
/**
|
|
4102
4084
|
* Deletes a user from the server.
|
|
4103
4085
|
*
|
|
4104
|
-
* Only administrators can delete users. If the current logged in user is not an
|
|
4105
|
-
* exception will be thrown.
|
|
4086
|
+
* Only administrators can delete users. If the current logged in user is not an
|
|
4087
|
+
* administrator, an exception will be thrown.
|
|
4106
4088
|
*
|
|
4107
|
-
* Administrators can delete themselves or other administrators. An administrator can only
|
|
4108
|
-
* themself if they is not the last administrator.
|
|
4089
|
+
* Administrators can delete themselves or other administrators. An administrator can only
|
|
4090
|
+
* delete themself if they is not the last administrator.
|
|
4109
4091
|
*
|
|
4110
4092
|
* You need to re-login after deleting the current logged in user.
|
|
4111
4093
|
*
|
|
@@ -4131,8 +4113,8 @@
|
|
|
4131
4113
|
}
|
|
4132
4114
|
}
|
|
4133
4115
|
/**
|
|
4134
|
-
* Saves user properties changes to the server. Call this method to update user data on the
|
|
4135
|
-
* after any property changes.
|
|
4116
|
+
* Saves user properties changes to the server. Call this method to update user data on the
|
|
4117
|
+
* server after any property changes.
|
|
4136
4118
|
*/
|
|
4137
4119
|
save() {
|
|
4138
4120
|
return this.update(this.data);
|
|
@@ -4140,15 +4122,16 @@
|
|
|
4140
4122
|
/**
|
|
4141
4123
|
* Sets or removes the user avatar.
|
|
4142
4124
|
*
|
|
4143
|
-
* Only administrators can set the avatar of other users. If the current logged in user is
|
|
4144
|
-
* administrator, they can only set their avatar, otherwise an exception will be thrown.
|
|
4125
|
+
* Only administrators can set the avatar of other users. If the current logged in user is
|
|
4126
|
+
* not an administrator, they can only set their avatar, otherwise an exception will be thrown.
|
|
4145
4127
|
*
|
|
4146
4128
|
* @param image - Avatar image. Can be a
|
|
4147
|
-
* {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
|
|
4129
|
+
* {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
|
|
4130
|
+
* string,
|
|
4148
4131
|
* {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer},
|
|
4149
4132
|
* {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob} or
|
|
4150
|
-
* {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object. Setting
|
|
4151
|
-
* to `null` will remove the avatar.
|
|
4133
|
+
* {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object. Setting
|
|
4134
|
+
* the `image` to `null` will remove the avatar.
|
|
4152
4135
|
*/
|
|
4153
4136
|
async setAvatar(image) {
|
|
4154
4137
|
if (!image) {
|
|
@@ -4172,8 +4155,8 @@
|
|
|
4172
4155
|
/**
|
|
4173
4156
|
* Removes the user avatar.
|
|
4174
4157
|
*
|
|
4175
|
-
* Only administrators can remove the avatar of other users. If the current logged in user is
|
|
4176
|
-
* administrator, they can only remove their avatar, otherwise an exception will be thrown.
|
|
4158
|
+
* Only administrators can remove the avatar of other users. If the current logged in user is
|
|
4159
|
+
* not an administrator, they can only remove their avatar, otherwise an exception will be thrown.
|
|
4177
4160
|
*/
|
|
4178
4161
|
async deleteAvatar() {
|
|
4179
4162
|
if (this.httpClient.signInUserIsAdmin) {
|
|
@@ -4194,14 +4177,15 @@
|
|
|
4194
4177
|
/**
|
|
4195
4178
|
* Changes the user password.
|
|
4196
4179
|
*
|
|
4197
|
-
* Only administrators can change the passwords of other users. If the current logged in user
|
|
4198
|
-
* administrator, they can only change their password, otherwise an exception will
|
|
4180
|
+
* Only administrators can change the passwords of other users. If the current logged in user
|
|
4181
|
+
* is not an administrator, they can only change their password, otherwise an exception will
|
|
4182
|
+
* be thrown.
|
|
4199
4183
|
*
|
|
4200
4184
|
* To change their password, non-administrator users must specify their old password.
|
|
4201
4185
|
*
|
|
4202
4186
|
* @param newPassword - New user password.
|
|
4203
|
-
* @param oldPassword - Old user password. Only required for non-administrator users to
|
|
4204
|
-
* password.
|
|
4187
|
+
* @param oldPassword - Old user password. Only required for non-administrator users to
|
|
4188
|
+
* change their password.
|
|
4205
4189
|
*/
|
|
4206
4190
|
async changePassword(newPassword, oldPassword) {
|
|
4207
4191
|
if (this.httpClient.signInUserIsAdmin) {
|
|
@@ -4244,8 +4228,8 @@
|
|
|
4244
4228
|
// acknowledge and accept the above terms.
|
|
4245
4229
|
///////////////////////////////////////////////////////////////////////////////
|
|
4246
4230
|
/**
|
|
4247
|
-
* Provides properties and methods for obtaining information about a OAuth 2.0 client that have
|
|
4248
|
-
* the Open Cloud Server API.
|
|
4231
|
+
* Provides properties and methods for obtaining information about a OAuth 2.0 client that have
|
|
4232
|
+
* access the Open Cloud Server API.
|
|
4249
4233
|
*/
|
|
4250
4234
|
class OAuthClient extends Endpoint {
|
|
4251
4235
|
/**
|
|
@@ -4349,8 +4333,8 @@
|
|
|
4349
4333
|
/**
|
|
4350
4334
|
* Updates client data on the server.
|
|
4351
4335
|
*
|
|
4352
|
-
* Only administrators can update OAuth clients. If the current logged in user is not an
|
|
4353
|
-
* an exception will be thrown.
|
|
4336
|
+
* Only administrators can update OAuth clients. If the current logged in user is not an
|
|
4337
|
+
* administrator, an exception will be thrown.
|
|
4354
4338
|
*
|
|
4355
4339
|
* @param data - Raw client data. For more information, see
|
|
4356
4340
|
* {@link https://cloud.opendesign.com/docs//pages/server/api.html#OAuthClient | Open Cloud OAuth Clients API}.
|
|
@@ -4363,8 +4347,8 @@
|
|
|
4363
4347
|
/**
|
|
4364
4348
|
* Deletes a client from the server.
|
|
4365
4349
|
*
|
|
4366
|
-
* Only administrators can delete OAuth clients. If the current logged in user is not an
|
|
4367
|
-
* an exception will be thrown.
|
|
4350
|
+
* Only administrators can delete OAuth clients. If the current logged in user is not an
|
|
4351
|
+
* administrator, an exception will be thrown.
|
|
4368
4352
|
*
|
|
4369
4353
|
* @returns Returns the raw data of a deleted client. For more information, see
|
|
4370
4354
|
* {@link https://cloud.opendesign.com/docs//pages/server/api.html#OAuthClient | Open Cloud OAuth Clients API}.
|
|
@@ -4373,11 +4357,11 @@
|
|
|
4373
4357
|
return super.delete("").then((response) => response.json());
|
|
4374
4358
|
}
|
|
4375
4359
|
/**
|
|
4376
|
-
* Saves client properties changes to the server. Call this method to update client data on
|
|
4377
|
-
* after any property changes.
|
|
4360
|
+
* Saves client properties changes to the server. Call this method to update client data on
|
|
4361
|
+
* the server after any property changes.
|
|
4378
4362
|
*
|
|
4379
|
-
* Only administrators can update OAuth clients. If the current logged in user is not an
|
|
4380
|
-
* an exception will be thrown.
|
|
4363
|
+
* Only administrators can update OAuth clients. If the current logged in user is not an
|
|
4364
|
+
* administrator, an exception will be thrown.
|
|
4381
4365
|
*/
|
|
4382
4366
|
save() {
|
|
4383
4367
|
return this.update(this.data);
|
|
@@ -4461,8 +4445,8 @@
|
|
|
4461
4445
|
// acknowledge and accept the above terms.
|
|
4462
4446
|
///////////////////////////////////////////////////////////////////////////////
|
|
4463
4447
|
/**
|
|
4464
|
-
* Provides methods for managing Open Cloud Server resources such as users, files, assemblies,
|
|
4465
|
-
* projects, etc.
|
|
4448
|
+
* Provides methods for managing Open Cloud Server resources such as users, files, assemblies,
|
|
4449
|
+
* jobs, projects, etc.
|
|
4466
4450
|
*/
|
|
4467
4451
|
class Client extends EventEmitter2 {
|
|
4468
4452
|
/**
|
|
@@ -4562,7 +4546,7 @@
|
|
|
4562
4546
|
.then((data) => ({
|
|
4563
4547
|
...data,
|
|
4564
4548
|
server: data.version,
|
|
4565
|
-
client: "26.1.
|
|
4549
|
+
client: "26.1.4",
|
|
4566
4550
|
}));
|
|
4567
4551
|
}
|
|
4568
4552
|
/**
|
|
@@ -4571,23 +4555,23 @@
|
|
|
4571
4555
|
* No login is required to register a new user.
|
|
4572
4556
|
*
|
|
4573
4557
|
* @param email - User email. Cannot be empty. Must be unique within the server.
|
|
4574
|
-
* @param password - User password. Cannot be empty. Password can only contain letters (a-z,
|
|
4575
|
-
* numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
|
|
4576
|
-
* @param userName - User name. Cannot be empty or blank if defined. this to `undefined` to
|
|
4577
|
-
* `username` from email.
|
|
4558
|
+
* @param password - User password. Cannot be empty. Password can only contain letters (a-z,
|
|
4559
|
+
* A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
|
|
4560
|
+
* @param userName - User name. Cannot be empty or blank if defined. this to `undefined` to
|
|
4561
|
+
* use `username` from email.
|
|
4578
4562
|
*/
|
|
4579
4563
|
registerUser(email, password, userName) {
|
|
4580
4564
|
return this.httpClient
|
|
4581
4565
|
.post("/register", {
|
|
4582
4566
|
email,
|
|
4583
4567
|
password,
|
|
4584
|
-
userName: userName !== null && userName !==
|
|
4568
|
+
userName: userName !== null && userName !== void 0 ? userName : (email + "").split("@").at(0),
|
|
4585
4569
|
})
|
|
4586
4570
|
.then((response) => response.json());
|
|
4587
4571
|
}
|
|
4588
4572
|
/**
|
|
4589
|
-
* Resends a Confirmation Email to the new user. If the user's email is already confirmed, an
|
|
4590
|
-
* will be thrown.
|
|
4573
|
+
* Resends a Confirmation Email to the new user. If the user's email is already confirmed, an
|
|
4574
|
+
* exception will be thrown.
|
|
4591
4575
|
*
|
|
4592
4576
|
* @param email - User email.
|
|
4593
4577
|
* @param password - User password.
|
|
@@ -4598,8 +4582,8 @@
|
|
|
4598
4582
|
.then((response) => response.json());
|
|
4599
4583
|
}
|
|
4600
4584
|
/**
|
|
4601
|
-
* Marks the user's email address as confirmed. If the user's email is already confirmed, an
|
|
4602
|
-
* will be thrown.
|
|
4585
|
+
* Marks the user's email address as confirmed. If the user's email is already confirmed, an
|
|
4586
|
+
* exception will be thrown.
|
|
4603
4587
|
*
|
|
4604
4588
|
* @param emailConfirmationId - Confirmation code from the Confirmation Email.
|
|
4605
4589
|
*/
|
|
@@ -4635,8 +4619,8 @@
|
|
|
4635
4619
|
/**
|
|
4636
4620
|
* Log out.
|
|
4637
4621
|
*
|
|
4638
|
-
* You must log in again using {@link signInWithEmail} or {@link signInWithToken} to continue
|
|
4639
|
-
* requests to the server
|
|
4622
|
+
* You must log in again using {@link signInWithEmail} or {@link signInWithToken} to continue
|
|
4623
|
+
* making requests to the server
|
|
4640
4624
|
*/
|
|
4641
4625
|
signOut() {
|
|
4642
4626
|
this.clearCurrentUser();
|
|
@@ -4656,8 +4640,8 @@
|
|
|
4656
4640
|
this.httpClient.signInUserIsAdmin = false;
|
|
4657
4641
|
}
|
|
4658
4642
|
/**
|
|
4659
|
-
* Returns the current logged in user. Returns `null` if the user is not logged in or the
|
|
4660
|
-
* user has deleted themself.
|
|
4643
|
+
* Returns the current logged in user. Returns `null` if the user is not logged in or the
|
|
4644
|
+
* logged in user has deleted themself.
|
|
4661
4645
|
*/
|
|
4662
4646
|
getCurrentUser() {
|
|
4663
4647
|
if (this._user && !this.httpClient.signInUserId)
|
|
@@ -4706,8 +4690,8 @@
|
|
|
4706
4690
|
/**
|
|
4707
4691
|
* Returns a list of OAuth clients of the server.
|
|
4708
4692
|
*
|
|
4709
|
-
* Only administrators can get a list of OAuth clients. If the current logged in user is not
|
|
4710
|
-
* administrator, an exception will be thrown.
|
|
4693
|
+
* Only administrators can get a list of OAuth clients. If the current logged in user is not
|
|
4694
|
+
* an administrator, an exception will be thrown.
|
|
4711
4695
|
*
|
|
4712
4696
|
* @param start - The starting index in the client list. Used for paging.
|
|
4713
4697
|
* @param limit - The maximum number of clients that should be returned per request. Used for paging.
|
|
@@ -4734,8 +4718,8 @@
|
|
|
4734
4718
|
/**
|
|
4735
4719
|
* Returns information about the specified OAuth client.
|
|
4736
4720
|
*
|
|
4737
|
-
* Only administrators can get OAuth clients. If the current logged in user is not an
|
|
4738
|
-
* exception will be thrown.
|
|
4721
|
+
* Only administrators can get OAuth clients. If the current logged in user is not an
|
|
4722
|
+
* administrator, an exception will be thrown.
|
|
4739
4723
|
*
|
|
4740
4724
|
* @param clientId - Client ID.
|
|
4741
4725
|
*/
|
|
@@ -4748,8 +4732,8 @@
|
|
|
4748
4732
|
/**
|
|
4749
4733
|
* Creates a new OAuth client on the server.
|
|
4750
4734
|
*
|
|
4751
|
-
* Only administrators can create OAuth clients. If the current logged in user is not an
|
|
4752
|
-
* an exception will be thrown.
|
|
4735
|
+
* Only administrators can create OAuth clients. If the current logged in user is not an
|
|
4736
|
+
* administrator, an exception will be thrown.
|
|
4753
4737
|
*
|
|
4754
4738
|
* @param name - Client name.
|
|
4755
4739
|
* @param redirectUrl - Endpoint to which the OAuth 2.0 server sends the response.
|
|
@@ -4768,8 +4752,8 @@
|
|
|
4768
4752
|
/**
|
|
4769
4753
|
* Deletes the specified OAuth client from the server.
|
|
4770
4754
|
*
|
|
4771
|
-
* Only administrators can delete OAuth clients. If the current logged in user is not an
|
|
4772
|
-
* an exception will be thrown.
|
|
4755
|
+
* Only administrators can delete OAuth clients. If the current logged in user is not an
|
|
4756
|
+
* administrator, an exception will be thrown.
|
|
4773
4757
|
*
|
|
4774
4758
|
* @param clientId - Client ID.
|
|
4775
4759
|
* @returns Returns the raw data of a deleted client. For more information, see
|
|
@@ -4781,8 +4765,8 @@
|
|
|
4781
4765
|
/**
|
|
4782
4766
|
* Returns the list of server users.
|
|
4783
4767
|
*
|
|
4784
|
-
* Only administrators can get a list of users. If the current logged in user is not an
|
|
4785
|
-
* an exception will be thrown.
|
|
4768
|
+
* Only administrators can get a list of users. If the current logged in user is not an
|
|
4769
|
+
* administrator, an exception will be thrown.
|
|
4786
4770
|
*/
|
|
4787
4771
|
getUsers() {
|
|
4788
4772
|
return this.httpClient
|
|
@@ -4794,8 +4778,8 @@
|
|
|
4794
4778
|
/**
|
|
4795
4779
|
* Returns information about the specified user.
|
|
4796
4780
|
*
|
|
4797
|
-
* Only administrators can get other users. If the current logged in user is not an
|
|
4798
|
-
* can only get themselves, otherwise an exception will be thrown.
|
|
4781
|
+
* Only administrators can get other users. If the current logged in user is not an
|
|
4782
|
+
* administrator, they can only get themselves, otherwise an exception will be thrown.
|
|
4799
4783
|
*
|
|
4800
4784
|
* @param userId - User ID.
|
|
4801
4785
|
*/
|
|
@@ -4821,16 +4805,16 @@
|
|
|
4821
4805
|
/**
|
|
4822
4806
|
* Creates a new user on the server.
|
|
4823
4807
|
*
|
|
4824
|
-
* Only administrators can create users. If the current logged in user is not an
|
|
4825
|
-
* exception will be thrown.
|
|
4808
|
+
* Only administrators can create users. If the current logged in user is not an
|
|
4809
|
+
* administrator, an exception will be thrown.
|
|
4826
4810
|
*
|
|
4827
4811
|
* @param email - User email. Cannot be empty. Must be unique within the server.
|
|
4828
|
-
* @param password - User password. Cannot be empty. Password can only contain latin letters
|
|
4829
|
-
* A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
|
|
4812
|
+
* @param password - User password. Cannot be empty. Password can only contain latin letters
|
|
4813
|
+
* (a-z, A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
|
|
4830
4814
|
* @param params - Additional user data.
|
|
4831
4815
|
* @param params.isAdmin - `true` if user is an administrator.
|
|
4832
|
-
* @param params.userName - User name. Cannot be empty or blank if defined. Specify
|
|
4833
|
-
* `username` from email.
|
|
4816
|
+
* @param params.userName - User name. Cannot be empty or blank if defined. Specify
|
|
4817
|
+
* `undefined` to use `username` from email.
|
|
4834
4818
|
* @param params.firstName - First name.
|
|
4835
4819
|
* @param params.lastName - Last name.
|
|
4836
4820
|
* @param params.canCreateProject - `true` if user is allowed to create a project.
|
|
@@ -4845,7 +4829,7 @@
|
|
|
4845
4829
|
userBrief: {
|
|
4846
4830
|
...rest,
|
|
4847
4831
|
email,
|
|
4848
|
-
userName: userName !== null && userName !==
|
|
4832
|
+
userName: userName !== null && userName !== void 0 ? userName : (email + "").split("@").at(0),
|
|
4849
4833
|
},
|
|
4850
4834
|
password,
|
|
4851
4835
|
})
|
|
@@ -4856,11 +4840,11 @@
|
|
|
4856
4840
|
/**
|
|
4857
4841
|
* Deletes the specified user from the server.
|
|
4858
4842
|
*
|
|
4859
|
-
* Only administrators can delete users. If the current logged in user is not an
|
|
4860
|
-
* exception will be thrown.
|
|
4843
|
+
* Only administrators can delete users. If the current logged in user is not an
|
|
4844
|
+
* administrator, an exception will be thrown.
|
|
4861
4845
|
*
|
|
4862
|
-
* Administrators can delete themselves or other administrators. An administrator can only
|
|
4863
|
-
* themself if they is not the last administrator.
|
|
4846
|
+
* Administrators can delete themselves or other administrators. An administrator can only
|
|
4847
|
+
* delete themself if they is not the last administrator.
|
|
4864
4848
|
*
|
|
4865
4849
|
* You need to re-login after deleting the current logged in user.
|
|
4866
4850
|
*
|
|
@@ -4900,12 +4884,12 @@
|
|
|
4900
4884
|
* @param start - The starting index in the file list. Used for paging.
|
|
4901
4885
|
* @param limit - The maximum number of files that should be returned per request. Used for paging.
|
|
4902
4886
|
* @param name - Filter the files by part of the name. Case sensitive.
|
|
4903
|
-
* @param ext - Filter the files by extension. Extension can be `dgn`, `dwf`, `dwg`, `dxf`,
|
|
4904
|
-
* `ifczip`, `nwc`, `nwd`, `obj`, `rcs`, `rfa`, `rvt`, `step`, `stl`, `stp`, `vsf`,
|
|
4905
|
-
* type extension.
|
|
4887
|
+
* @param ext - Filter the files by extension. Extension can be `dgn`, `dwf`, `dwg`, `dxf`,
|
|
4888
|
+
* `ifc`, `ifczip`, `nwc`, `nwd`, `obj`, `rcs`, `rfa`, `rvt`, `step`, `stl`, `stp`, `vsf`,
|
|
4889
|
+
* or any other file type extension.
|
|
4906
4890
|
* @param ids - List of file IDs to return.
|
|
4907
|
-
* @param sortByDesc - Allows to specify the descending order of the result. By default,
|
|
4908
|
-
* sorted by name in ascending order.
|
|
4891
|
+
* @param sortByDesc - Allows to specify the descending order of the result. By default,
|
|
4892
|
+
* files are sorted by name in ascending order.
|
|
4909
4893
|
* @param sortField - Allows to specify sort field.
|
|
4910
4894
|
* @param shared - Returns shared files only.
|
|
4911
4895
|
*/
|
|
@@ -4967,9 +4951,10 @@
|
|
|
4967
4951
|
*
|
|
4968
4952
|
* - {@link UploadProgressEvent | uploadprogress}
|
|
4969
4953
|
*
|
|
4970
|
-
* @param file - {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object
|
|
4971
|
-
* generally retrieved from a
|
|
4972
|
-
*
|
|
4954
|
+
* @param file - {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object
|
|
4955
|
+
* are generally retrieved from a
|
|
4956
|
+
* {@link https://developer.mozilla.org/docs/Web/API/FileList | FileList} object returned as
|
|
4957
|
+
* a result of a user selecting files using the HTML `<input>` element.
|
|
4973
4958
|
* @param params - An object containing upload parameters.
|
|
4974
4959
|
* @param params.geometry - Create job to convert file geometry data. Can be:
|
|
4975
4960
|
*
|
|
@@ -4979,13 +4964,13 @@
|
|
|
4979
4964
|
*
|
|
4980
4965
|
* @param params.properties - Create job to extract file properties.
|
|
4981
4966
|
* @param params.waitForDone - Wait for geometry and properties jobs to complete.
|
|
4982
|
-
* @param params.timeout - The time, in milliseconds that the function should wait jobs. If
|
|
4983
|
-
* are done during this time, the `TimeoutError` exception will be thrown.
|
|
4984
|
-
* @param params.interval - The time, in milliseconds, the function should delay in between
|
|
4985
|
-
* jobs status.
|
|
4967
|
+
* @param params.timeout - The time, in milliseconds that the function should wait jobs. If
|
|
4968
|
+
* no one jobs are done during this time, the `TimeoutError` exception will be thrown.
|
|
4969
|
+
* @param params.interval - The time, in milliseconds, the function should delay in between
|
|
4970
|
+
* checking jobs status.
|
|
4986
4971
|
* @param params.signal - An
|
|
4987
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
4988
|
-
* can be used to abort waiting as desired.
|
|
4972
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
4973
|
+
* signal, which can be used to abort waiting as desired.
|
|
4989
4974
|
* @param params.onProgress - Upload progress callback.
|
|
4990
4975
|
*/
|
|
4991
4976
|
async uploadFile(file, params = {
|
|
@@ -4997,7 +4982,7 @@
|
|
|
4997
4982
|
.uploadFile("/files", file, (progress) => {
|
|
4998
4983
|
var _a;
|
|
4999
4984
|
this.emitEvent({ type: "uploadprogress", data: progress, file });
|
|
5000
|
-
(_a = params.onProgress) === null || _a ===
|
|
4985
|
+
(_a = params.onProgress) === null || _a === void 0 ? void 0 : _a.call(params, progress, file);
|
|
5001
4986
|
})
|
|
5002
4987
|
.then((xhr) => JSON.parse(xhr.responseText))
|
|
5003
4988
|
.then((data) => new File(data, this.httpClient));
|
|
@@ -5017,8 +5002,8 @@
|
|
|
5017
5002
|
/**
|
|
5018
5003
|
* Deletes the specified file and all its versions from the server.
|
|
5019
5004
|
*
|
|
5020
|
-
* You cannot delete a version file using `deleteFile()`, only the original file. To delete a
|
|
5021
|
-
* file use {@link File.deleteVersion | File.deleteVersion()}.
|
|
5005
|
+
* You cannot delete a version file using `deleteFile()`, only the original file. To delete a
|
|
5006
|
+
* version file use {@link File.deleteVersion | File.deleteVersion()}.
|
|
5022
5007
|
*
|
|
5023
5008
|
* @param fileId - File ID.
|
|
5024
5009
|
* @returns Returns the raw data of a deleted file. For more information, see
|
|
@@ -5033,8 +5018,8 @@
|
|
|
5033
5018
|
* @param fileId - File ID.
|
|
5034
5019
|
* @param onProgress - Download progress callback.
|
|
5035
5020
|
* @param signal - An
|
|
5036
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
5037
|
-
* to communicate with a fetch request and abort it if desired.
|
|
5021
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
5022
|
+
* signal. Allows to communicate with a fetch request and abort it if desired.
|
|
5038
5023
|
*/
|
|
5039
5024
|
downloadFile(fileId, onProgress, signal) {
|
|
5040
5025
|
return this.httpClient
|
|
@@ -5057,8 +5042,8 @@
|
|
|
5057
5042
|
* @param status - Filter the jobs by status. Status can be `waiting`, `inpogress`, `done` or `failed`.
|
|
5058
5043
|
* @param limit - The maximum number of jobs that should be returned per request. Used for paging.
|
|
5059
5044
|
* @param start - The starting index in the job list. Used for paging.
|
|
5060
|
-
* @param sortByDesc - Allows to specify the descending order of the result. By default, jobs
|
|
5061
|
-
* sorted by creation time in ascending order.
|
|
5045
|
+
* @param sortByDesc - Allows to specify the descending order of the result. By default, jobs
|
|
5046
|
+
* are sorted by creation time in ascending order.
|
|
5062
5047
|
* @param {boolean} sortField - Allows to specify sort field.
|
|
5063
5048
|
*/
|
|
5064
5049
|
getJobs(status, limit, start, sortByDesc, sortField) {
|
|
@@ -5112,11 +5097,11 @@
|
|
|
5112
5097
|
* - `properties` - Extract file properties.
|
|
5113
5098
|
* - `validation` - Validate the file. Only for `IFC` files.
|
|
5114
5099
|
* - `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` - Export file to the one of the supported format.
|
|
5115
|
-
* - Other custom job name. Custom job runner must be registered in the job templates table
|
|
5116
|
-
* creating a job.
|
|
5100
|
+
* - Other custom job name. Custom job runner must be registered in the job templates table
|
|
5101
|
+
* before creating a job.
|
|
5117
5102
|
*
|
|
5118
|
-
* @param parameters - Parameters for the job runner. Can be given as command line arguments
|
|
5119
|
-
* File Converter tool in form `--arg=value`.
|
|
5103
|
+
* @param parameters - Parameters for the job runner. Can be given as command line arguments
|
|
5104
|
+
* for the File Converter tool in form `--arg=value`.
|
|
5120
5105
|
*/
|
|
5121
5106
|
createJob(fileId, outputFormat, parameters) {
|
|
5122
5107
|
return this.httpClient
|
|
@@ -5129,8 +5114,8 @@
|
|
|
5129
5114
|
.then((data) => new Job(data, this.httpClient));
|
|
5130
5115
|
}
|
|
5131
5116
|
/**
|
|
5132
|
-
* Deletes the specified job from the server job list. Jobs that are in progress or have
|
|
5133
|
-
* completed cannot be deleted.
|
|
5117
|
+
* Deletes the specified job from the server job list. Jobs that are in progress or have
|
|
5118
|
+
* already been completed cannot be deleted.
|
|
5134
5119
|
*
|
|
5135
5120
|
* @param jobId - Job ID.
|
|
5136
5121
|
* @returns Returns the raw data of a deleted job. For more information, see
|
|
@@ -5153,12 +5138,12 @@
|
|
|
5153
5138
|
* Returns a list of assemblies created by the current logged in user.
|
|
5154
5139
|
*
|
|
5155
5140
|
* @param start - The starting index in the assembly list. Used for paging.
|
|
5156
|
-
* @param limit - The maximum number of assemblies that should be returned per request. Used
|
|
5157
|
-
* paging.
|
|
5141
|
+
* @param limit - The maximum number of assemblies that should be returned per request. Used
|
|
5142
|
+
* for paging.
|
|
5158
5143
|
* @param name - Filter the assemblies by part of the name. Case sensitive.
|
|
5159
5144
|
* @param ids - List of assembly IDs to return.
|
|
5160
|
-
* @param sortByDesc - Allows to specify the descending order of the result. By default
|
|
5161
|
-
* sorted by name in ascending order.
|
|
5145
|
+
* @param sortByDesc - Allows to specify the descending order of the result. By default
|
|
5146
|
+
* assemblies are sorted by name in ascending order.
|
|
5162
5147
|
* @param sortField - Allows to specify sort field.
|
|
5163
5148
|
*/
|
|
5164
5149
|
getAssemblies(start, limit, name, ids, sortByDesc, sortField) {
|
|
@@ -5212,18 +5197,18 @@
|
|
|
5212
5197
|
* @param name - Assembly name.
|
|
5213
5198
|
* @param params - Additional assembly creating parameters.
|
|
5214
5199
|
* @param params.waitForDone - Wait for assembly to be created.
|
|
5215
|
-
* @param params.timeout - The time, in milliseconds, that the function should wait for the
|
|
5216
|
-
* be created. If the assembly is not created within this time, a TimeoutError
|
|
5217
|
-
* thrown.
|
|
5218
|
-
* @param params.interval - The time, in milliseconds, the function should delay in between
|
|
5219
|
-
* assembly status.
|
|
5200
|
+
* @param params.timeout - The time, in milliseconds, that the function should wait for the
|
|
5201
|
+
* assembly to be created. If the assembly is not created within this time, a TimeoutError
|
|
5202
|
+
* exception will be thrown.
|
|
5203
|
+
* @param params.interval - The time, in milliseconds, the function should delay in between
|
|
5204
|
+
* checking assembly status.
|
|
5220
5205
|
* @param params.signal - An
|
|
5221
|
-
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
5222
|
-
* can be used to abort waiting as desired.
|
|
5206
|
+
* {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
|
|
5207
|
+
* signal, which can be used to abort waiting as desired.
|
|
5223
5208
|
* @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
|
|
5224
5209
|
*/
|
|
5225
5210
|
createAssembly(files, name, params) {
|
|
5226
|
-
const { waitForDone } = params !== null && params !==
|
|
5211
|
+
const { waitForDone } = params !== null && params !== void 0 ? params : {};
|
|
5227
5212
|
return this.httpClient
|
|
5228
5213
|
.post("/assemblies", { name, files })
|
|
5229
5214
|
.then((response) => response.json())
|
|
@@ -5257,8 +5242,8 @@
|
|
|
5257
5242
|
* @param limit - The maximum number of projects that should be returned per request. Used for paging.
|
|
5258
5243
|
* @param name - Filter the projects by part of the name. Case sensitive.
|
|
5259
5244
|
* @param ids - List of project IDs to return.
|
|
5260
|
-
* @param sortByDesc - Allows to specify the descending order of the result. By default
|
|
5261
|
-
* sorted by name in ascending order.
|
|
5245
|
+
* @param sortByDesc - Allows to specify the descending order of the result. By default
|
|
5246
|
+
* projects are sorted by name in ascending order.
|
|
5262
5247
|
*/
|
|
5263
5248
|
getProjects(start, limit, name, ids, sortByDesc) {
|
|
5264
5249
|
const searchParams = new URLSearchParams();
|
|
@@ -5393,8 +5378,8 @@
|
|
|
5393
5378
|
/**
|
|
5394
5379
|
* Deletes the specified shared link.
|
|
5395
5380
|
*
|
|
5396
|
-
* Only file owner can delete shared link. If the current logged in user is not a file owner,
|
|
5397
|
-
* exception will be thrown.
|
|
5381
|
+
* Only file owner can delete shared link. If the current logged in user is not a file owner,
|
|
5382
|
+
* an exception will be thrown.
|
|
5398
5383
|
*
|
|
5399
5384
|
* @param token - Shared link token.
|
|
5400
5385
|
* @returns Returns the raw data of a deleted shared link. For more information, see
|
|
@@ -5447,7 +5432,7 @@
|
|
|
5447
5432
|
// By use of this software, its documentation or related materials, you
|
|
5448
5433
|
// acknowledge and accept the above terms.
|
|
5449
5434
|
///////////////////////////////////////////////////////////////////////////////
|
|
5450
|
-
const version = "26.1.
|
|
5435
|
+
const version = "26.1.4";
|
|
5451
5436
|
|
|
5452
5437
|
exports.Assembly = Assembly;
|
|
5453
5438
|
exports.ClashTest = ClashTest;
|