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