@inweb/client 25.8.19 → 25.8.21

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.
@@ -189,7 +189,7 @@ export declare class Assembly {
189
189
  */
190
190
  getViewpoints(): Promise<any[]>;
191
191
  /**
192
- * Adds a new viewpoint to the assembly. To create a viewpoint use `Viewer.createViewpoint()`.
192
+ * Saves a new assembly viewpoint to the server. To create a viewpoint use `Viewer.createViewpoint()`.
193
193
  *
194
194
  * @param viewpoint - Viewpoint.
195
195
  */
@@ -200,16 +200,16 @@ export declare class Assembly {
200
200
  * @param guid - Viewpoint GUID.
201
201
  * @returns Returns the raw data of a deleted viewpoint.
202
202
  */
203
- deleteViewpoint(guid: any): Promise<any>;
203
+ deleteViewpoint(guid: string): Promise<any>;
204
204
  /**
205
- * Returns viewpoint preview image as
205
+ * Returns viewpoint snapshot as base64-encoded
206
206
  * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
207
207
  *
208
208
  * @param guid - Viewpoint GUID.
209
209
  */
210
- getSnapshot(guid: any): Promise<any>;
210
+ getSnapshot(guid: string): Promise<string>;
211
211
  /**
212
- * Returns viewpoint preview data.
212
+ * Returns viewpoint snapshot data.
213
213
  *
214
214
  * @param guid - Viewpoint GUID.
215
215
  * @param bitmapGuid - Bitmap GUID.
package/lib/Api/File.d.ts CHANGED
@@ -293,7 +293,7 @@ export declare class File {
293
293
  */
294
294
  getViewpoints(): Promise<any[]>;
295
295
  /**
296
- * Adds a new viewpoint to the file. To create a viewpoint use `Viewer.createViewpoint()`.
296
+ * Saves a new file viewpoint to the server. To create a viewpoint use `Viewer.createViewpoint()`.
297
297
  *
298
298
  * @param viewpoint - Viewpoint.
299
299
  */
@@ -306,14 +306,14 @@ export declare class File {
306
306
  */
307
307
  deleteViewpoint(guid: string): Promise<any>;
308
308
  /**
309
- * Returns viewpoint preview image as
309
+ * Returns viewpoint snapshot as base64-encoded
310
310
  * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
311
311
  *
312
312
  * @param guid - Viewpoint GUID.
313
313
  */
314
314
  getSnapshot(guid: string): Promise<string>;
315
315
  /**
316
- * Returns viewpoint preview data.
316
+ * Returns viewpoint snapshot data.
317
317
  *
318
318
  * @param guid - Viewpoint GUID.
319
319
  * @param bitmapGuid - Bitmap GUID.
@@ -492,7 +492,7 @@ export declare class File {
492
492
  * - `readViewpoint` - The ability to read file viewpoints.
493
493
  * - `createViewpoint` - The ability to create file viewpoints.
494
494
  *
495
- * @param grantedTo - A collection of principials that will get access to the file.
495
+ * @param grantedTo - A list of principials that will get access to the file.
496
496
  * @param _public - Specifies whether all users have access to the file or not.
497
497
  */
498
498
  createPermission(actions: string | string[], grantedTo: any[], _public: boolean): Promise<Permission>;
@@ -27,7 +27,7 @@ export interface IFileReference {
27
27
  */
28
28
  export interface IFileReferences {
29
29
  /**
30
- * The references ID, changed after each update of the file references.
30
+ * The references list ID, changed after each update of the file references.
31
31
  */
32
32
  id: string;
33
33
  /**
@@ -103,8 +103,8 @@ export declare class Model {
103
103
  */
104
104
  getViewpoints(): Promise<any[]>;
105
105
  /**
106
- * Adds a new viewpoint to the owner file/assembly. To create a new viewpoint use
107
- * `Viewer.createViewpoint()`.
106
+ * Saves a new model owner file/assembly viewpoint to the server. To create a new viewpoint
107
+ * use `Viewer.createViewpoint()`.
108
108
  *
109
109
  * @param viewpoint - Viewpoint.
110
110
  */
@@ -117,10 +117,10 @@ export declare class Model {
117
117
  */
118
118
  deleteViewpoint(guid: string): Promise<any>;
119
119
  /**
120
- * Returns viewpoint preview image as
120
+ * Returns viewpoint snapshot as base64-encoded
121
121
  * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
122
122
  *
123
- * @param guid - Viewpoint GIID.
123
+ * @param guid - Viewpoint GUID.
124
124
  */
125
125
  getSnapshot(guid: string): Promise<string>;
126
126
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@inweb/client",
3
- "version": "25.8.19",
3
+ "version": "25.8.21",
4
4
  "description": "JavaScript REST API client for the Open Cloud Server",
5
5
  "homepage": "https://cloud.opendesign.com/docs/index.html",
6
6
  "license": "SEE LICENSE IN LICENSE",
@@ -26,6 +26,6 @@
26
26
  "docs": "typedoc"
27
27
  },
28
28
  "dependencies": {
29
- "@inweb/eventemitter2": "~25.8.19"
29
+ "@inweb/eventemitter2": "~25.8.21"
30
30
  }
31
31
  }
@@ -364,7 +364,7 @@ export class Assembly {
364
364
  }
365
365
 
366
366
  /**
367
- * Adds a new viewpoint to the assembly. To create a viewpoint use `Viewer.createViewpoint()`.
367
+ * Saves a new assembly viewpoint to the server. To create a viewpoint use `Viewer.createViewpoint()`.
368
368
  *
369
369
  * @param viewpoint - Viewpoint.
370
370
  */
@@ -378,22 +378,22 @@ export class Assembly {
378
378
  * @param guid - Viewpoint GUID.
379
379
  * @returns Returns the raw data of a deleted viewpoint.
380
380
  */
381
- deleteViewpoint(guid: any): Promise<any> {
381
+ deleteViewpoint(guid: string): Promise<any> {
382
382
  return this.internalDelete(`/viewpoints/${guid}`).then((response) => response.json());
383
383
  }
384
384
 
385
385
  /**
386
- * Returns viewpoint preview image as
386
+ * Returns viewpoint snapshot as base64-encoded
387
387
  * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
388
388
  *
389
389
  * @param guid - Viewpoint GUID.
390
390
  */
391
- getSnapshot(guid: any): Promise<any> {
391
+ getSnapshot(guid: string): Promise<string> {
392
392
  return this.internalGet(`/viewpoints/${guid}/snapshot`).then((response) => response.text());
393
393
  }
394
394
 
395
395
  /**
396
- * Returns viewpoint preview data.
396
+ * Returns viewpoint snapshot data.
397
397
  *
398
398
  * @param guid - Viewpoint GUID.
399
399
  * @param bitmapGuid - Bitmap GUID.
package/src/Api/File.ts CHANGED
@@ -505,7 +505,7 @@ export class File {
505
505
  }
506
506
 
507
507
  /**
508
- * Adds a new viewpoint to the file. To create a viewpoint use `Viewer.createViewpoint()`.
508
+ * Saves a new file viewpoint to the server. To create a viewpoint use `Viewer.createViewpoint()`.
509
509
  *
510
510
  * @param viewpoint - Viewpoint.
511
511
  */
@@ -524,7 +524,7 @@ export class File {
524
524
  }
525
525
 
526
526
  /**
527
- * Returns viewpoint preview image as
527
+ * Returns viewpoint snapshot as base64-encoded
528
528
  * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
529
529
  *
530
530
  * @param guid - Viewpoint GUID.
@@ -534,7 +534,7 @@ export class File {
534
534
  }
535
535
 
536
536
  /**
537
- * Returns viewpoint preview data.
537
+ * Returns viewpoint snapshot data.
538
538
  *
539
539
  * @param guid - Viewpoint GUID.
540
540
  * @param bitmapGuid - Bitmap GUID.
@@ -816,7 +816,7 @@ export class File {
816
816
  * - `readViewpoint` - The ability to read file viewpoints.
817
817
  * - `createViewpoint` - The ability to create file viewpoints.
818
818
  *
819
- * @param grantedTo - A collection of principials that will get access to the file.
819
+ * @param grantedTo - A list of principials that will get access to the file.
820
820
  * @param _public - Specifies whether all users have access to the file or not.
821
821
  */
822
822
  createPermission(actions: string | string[], grantedTo: any[], _public: boolean): Promise<Permission> {
package/src/Api/IFile.ts CHANGED
@@ -54,7 +54,7 @@ export interface IFileReference {
54
54
  */
55
55
  export interface IFileReferences {
56
56
  /**
57
- * The references ID, changed after each update of the file references.
57
+ * The references list ID, changed after each update of the file references.
58
58
  */
59
59
  id: string;
60
60
 
package/src/Api/Model.ts CHANGED
@@ -189,8 +189,8 @@ export class Model {
189
189
  }
190
190
 
191
191
  /**
192
- * Adds a new viewpoint to the owner file/assembly. To create a new viewpoint use
193
- * `Viewer.createViewpoint()`.
192
+ * Saves a new model owner file/assembly viewpoint to the server. To create a new viewpoint
193
+ * use `Viewer.createViewpoint()`.
194
194
  *
195
195
  * @param viewpoint - Viewpoint.
196
196
  */
@@ -212,10 +212,10 @@ export class Model {
212
212
  }
213
213
 
214
214
  /**
215
- * Returns viewpoint preview image as
215
+ * Returns viewpoint snapshot as base64-encoded
216
216
  * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
217
217
  *
218
- * @param guid - Viewpoint GIID.
218
+ * @param guid - Viewpoint GUID.
219
219
  */
220
220
  getSnapshot(guid: string): Promise<string> {
221
221
  return this._file.getSnapshot(guid);