@inweb/client 25.9.7 → 25.9.8

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.
@@ -1,5 +1,5 @@
1
1
  import { IHttpClient } from "./IHttpClient";
2
- import { IFileReferences } from "./IFile";
2
+ import { ICdaNode, IFileReferences } from "./IFile";
3
3
  import { IAssociatedFileData, IAssemblyVersionInfo, IModelTransformMatrix } from "./IAssembly";
4
4
  import { IShortUserDesc } from "./IUser";
5
5
  import { Model } from "./Model";
@@ -184,7 +184,7 @@ export declare class Assembly {
184
184
  /**
185
185
  * Returns the CDA tree for an assembly.
186
186
  */
187
- getCdaTree(): Promise<any[]>;
187
+ getCdaTree(): Promise<ICdaNode[]>;
188
188
  /**
189
189
  * Returns a list of assembly viewpoints. For more information, see
190
190
  * {@link https://cloud.opendesign.com/docs//pages/server/api.html#AssemblyViewpoints | Open Cloud Assembly Viewpoints API}.
package/lib/Api/File.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { IHttpClient } from "./IHttpClient";
2
- import { IFileStatus, IFileReferences, IFileVersionInfo, IGrantedTo } from "./IFile";
2
+ import { ICdaNode, IFileStatus, IFileReferences, IFileVersionInfo, IGrantedTo } from "./IFile";
3
3
  import { IShortUserDesc } from "./IUser";
4
4
  import { Model } from "./Model";
5
5
  import { Permission } from "./Permission";
@@ -275,7 +275,7 @@ export declare class File {
275
275
  /**
276
276
  * Returns the CDA tree for an active version of the file.
277
277
  */
278
- getCdaTree(): Promise<any[]>;
278
+ getCdaTree(): Promise<ICdaNode[]>;
279
279
  /**
280
280
  * Returns a list of file viewpoints. For more information, see
281
281
  * {@link https://cloud.opendesign.com/docs//pages/server/api.html#FileViewpoints | Open Cloud File Viewpoints API}.
@@ -136,3 +136,20 @@ export interface IGrantedTo {
136
136
  name: string;
137
137
  };
138
138
  }
139
+ /**
140
+ * Defines the CDA tree node.
141
+ */
142
+ export interface ICdaNode {
143
+ /**
144
+ * Object original handle.
145
+ */
146
+ handle: string;
147
+ /**
148
+ * Object name.
149
+ */
150
+ name: string;
151
+ /**
152
+ * Nested objects.
153
+ */
154
+ children: ICdaNode[];
155
+ }
package/lib/index.d.ts CHANGED
@@ -7,7 +7,7 @@ export { FetchError, statusText } from "./Api/FetchError";
7
7
  export { Job } from "./Api/Job";
8
8
  export { IHttpClient } from "./Api/IHttpClient";
9
9
  export { IAssociatedFileData, IClashItem, IModelTransformMatrix } from "./Api/IAssembly";
10
- export { IFileDataStatus, IFileReference, IFileReferences, IFileStatus, IFileVersionInfo, IGrantedTo, } from "./Api/IFile";
10
+ export { ICdaNode, IFileDataStatus, IFileReference, IFileReferences, IFileStatus, IFileVersionInfo, IGrantedTo, } from "./Api/IFile";
11
11
  export { IRoleActions } from "./Api/IRole";
12
12
  export { IShortUserDesc } from "./Api/IUser";
13
13
  export { Member } from "./Api/Member";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@inweb/client",
3
- "version": "25.9.7",
3
+ "version": "25.9.8",
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.9.7"
29
+ "@inweb/eventemitter2": "~25.9.8"
30
30
  }
31
31
  }
@@ -23,7 +23,7 @@
23
23
 
24
24
  import { IHttpClient } from "./IHttpClient";
25
25
  import { FetchError } from "./FetchError";
26
- import { IFileReferences } from "./IFile";
26
+ import { ICdaNode, IFileReferences } from "./IFile";
27
27
  import { IAssociatedFileData, IAssemblyVersionInfo, IModelTransformMatrix } from "./IAssembly";
28
28
  import { IShortUserDesc } from "./IUser";
29
29
  import { Model } from "./Model";
@@ -352,7 +352,7 @@ export class Assembly {
352
352
  /**
353
353
  * Returns the CDA tree for an assembly.
354
354
  */
355
- getCdaTree(): Promise<any[]> {
355
+ getCdaTree(): Promise<ICdaNode[]> {
356
356
  return this.internalGet(`/properties/tree`).then((response) => response.json());
357
357
  }
358
358
 
package/src/Api/File.ts CHANGED
@@ -22,7 +22,7 @@
22
22
  ///////////////////////////////////////////////////////////////////////////////
23
23
 
24
24
  import { IHttpClient } from "./IHttpClient";
25
- import { IFileStatus, IFileReferences, IFileVersionInfo, IGrantedTo } from "./IFile";
25
+ import { ICdaNode, IFileStatus, IFileReferences, IFileVersionInfo, IGrantedTo } from "./IFile";
26
26
  import { IShortUserDesc } from "./IUser";
27
27
  import { Model } from "./Model";
28
28
  import { Permission } from "./Permission";
@@ -479,7 +479,7 @@ export class File {
479
479
  /**
480
480
  * Returns the CDA tree for an active version of the file.
481
481
  */
482
- getCdaTree(): Promise<any[]> {
482
+ getCdaTree(): Promise<ICdaNode[]> {
483
483
  return this.internalGet(`/properties/tree`).then((response) => response.json());
484
484
  }
485
485
 
package/src/Api/IFile.ts CHANGED
@@ -182,3 +182,23 @@ export interface IGrantedTo {
182
182
  name: string;
183
183
  };
184
184
  }
185
+
186
+ /**
187
+ * Defines the CDA tree node.
188
+ */
189
+ export interface ICdaNode {
190
+ /**
191
+ * Object original handle.
192
+ */
193
+ handle: string;
194
+
195
+ /**
196
+ * Object name.
197
+ */
198
+ name: string;
199
+
200
+ /**
201
+ * Nested objects.
202
+ */
203
+ children: ICdaNode[];
204
+ }
package/src/index.ts CHANGED
@@ -31,6 +31,7 @@ export { Job } from "./Api/Job";
31
31
  export { IHttpClient } from "./Api/IHttpClient";
32
32
  export { IAssociatedFileData, IClashItem, IModelTransformMatrix } from "./Api/IAssembly";
33
33
  export {
34
+ ICdaNode,
34
35
  IFileDataStatus,
35
36
  IFileReference,
36
37
  IFileReferences,