@3dverse/api 0.8.21 → 0.8.22

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.
@@ -508,15 +508,7 @@ export type UploadSourceFiles_Object = {
508
508
  upload_task_id?: string;
509
509
  };
510
510
  /**
511
- * Uploads the specified source file(s).
512
- * The supported file formats are:
513
- * - Scene :
514
- * - Mesh : `fbx, obj/mtl, stl, ply, ifc, usd, usda, usdc, usdz, skp, ptf, 3ds, 3mf, ac, ac3d, acc, amj, ase, ask, b3d, blend, bvh, cms, cob, dae, dxf, gltf/bin, glb, enff, hmb, irr, irrmesh, lwo, lws, lxo, m3d, md2, md3, md5, mdc, mdl, xml, mot, ms3d, ndo, nff, off, ogex, pmx, prj, q3o, q3s, raw, scn, sib, smd, ter, uc, vta, wrl, x, x3d, xgl, zgl`
515
- * - Point cloud : `e57, ptx, xyz, las, laz`
516
- * - Volume : `dcm`
517
- * - Texture : `jpg, jpeg, png, tga, dds, tif, tiff, bmp, rgbe`
518
- * - Cubemap : `hdr`
519
- * - Sound : `wav, mp3, ogg, flac`.
511
+ * Uploads the specified source file(s). The accepted extensions, their conversion type and per-converter options are listed by `GET /source-files/supported-formats` and documented at https://docs.3dverse.com/references/supported-file-formats.
520
512
  */
521
513
  export declare function uploadSourceFiles({ folder_id, body, }: {
522
514
  folder_id: string;
@@ -729,7 +721,8 @@ export declare function createCubemap({ folder_id, faces, name, }: {
729
721
  export type ImportAssets__index_ImportAssetsResponse_ImportAssetsResponse = {
730
722
  /** List of asset ids contained in the package */
731
723
  asset_ids: ImportAssets_AssetIds;
732
- /** List of skipped file names in the package */
724
+ /** List of skipped file names in the package. Includes the payload files of shader, script and animation_sequence assets, whose payload is intentionally not imported (only their description is).
725
+ */
733
726
  skipped_files?: Array<string>;
734
727
  };
735
728
  export type ImportAssets_AssetIds = {
@@ -790,8 +783,10 @@ export type GetSessionsInFolder_Session = {
790
783
  folder_id: string;
791
784
  /** Maximum number of users allowed in this session at the same time */
792
785
  max_users: number;
793
- /** User identifier of the creator of the session */
786
+ /** @deprecated User identifier of the creator of the session (deprecated, use `created_by` instead) */
794
787
  creator_user_id: string;
788
+ /** User identifier of the creator of the session */
789
+ created_by?: GetSessionsInFolder_CreatedBy;
795
790
  /** Session creation date */
796
791
  created_at: string;
797
792
  /** Country code of the rendering server location */
@@ -803,6 +798,12 @@ export type GetSessionsInFolder_Session = {
803
798
  /** Current clients in session */
804
799
  clients: Array<GetSessionsInFolder_Client_UserInfo>;
805
800
  };
801
+ export type GetSessionsInFolder_CreatedBy = {
802
+ /** User unique identifier */
803
+ user_id?: string;
804
+ username?: string;
805
+ required?: any;
806
+ };
806
807
  export type GetSessionsInFolder_Client_UserInfo = {
807
808
  /** Client unique identifier */
808
809
  client_id?: string;
@@ -849,6 +850,34 @@ export declare function deleteSourceFiles({ source_file_ids, delete_assets, }: {
849
850
  */
850
851
  delete_assets?: boolean;
851
852
  }, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
853
+ export type GetSupportedSourceFileFormats_SupportedSourceFileFormats = {
854
+ /** Files accepted by one conversion type. Aggregates are the union over its converters. */
855
+ cubemap: GetSupportedSourceFileFormats_SupportedFormat;
856
+ /** Files accepted by one conversion type. Aggregates are the union over its converters. */
857
+ point_cloud: GetSupportedSourceFileFormats_SupportedFormat;
858
+ /** Files accepted by one conversion type. Aggregates are the union over its converters. */
859
+ scene: GetSupportedSourceFileFormats_SupportedFormat;
860
+ /** Files accepted by one conversion type. Aggregates are the union over its converters. */
861
+ sound: GetSupportedSourceFileFormats_SupportedFormat;
862
+ /** Files accepted by one conversion type. Aggregates are the union over its converters. */
863
+ texture: GetSupportedSourceFileFormats_SupportedFormat;
864
+ /** Files accepted by one conversion type. Aggregates are the union over its converters. */
865
+ volume: GetSupportedSourceFileFormats_SupportedFormat;
866
+ };
867
+ export type GetSupportedSourceFileFormats_SupportedFormat = {
868
+ /** Extra file extensions to bundle with a given primary extension. */
869
+ associated_file_extensions?: GetSupportedSourceFileFormats_Object;
870
+ /** Per sub-pipeline breakdown, keyed by converter name. */
871
+ converters: GetSupportedSourceFileFormats_Object;
872
+ file_extensions: Array<string>;
873
+ };
874
+ export type GetSupportedSourceFileFormats_Object = {
875
+ [_additionalproperties_: string]: Array<string>;
876
+ };
877
+ /**
878
+ * Returns the source file formats accepted for conversion, grouped by conversion type, with the per-converter breakdown and each converter's options schema.
879
+ */
880
+ export declare function getSupportedSourceFileFormats(headers?: AxiosRequestHeaders): AxiosPromise<GetSupportedSourceFileFormats_SupportedSourceFileFormats>;
852
881
  /**
853
882
  * Downloads the target source file.
854
883
  */
@@ -1776,7 +1805,7 @@ export type GetAssetDescription_Shader = {
1776
1805
  };
1777
1806
  export type GetAssetDescription_ComputeShaderSettings = {
1778
1807
  /** Global group reference */
1779
- sizeReference?: StrictUnion<0 | 1 | 2>;
1808
+ sizeReference?: StrictUnion<0 | 1 | 2 | 3>;
1780
1809
  /** Size of the workgroup */
1781
1810
  workgroupSize?: Array<number>;
1782
1811
  /** Scaling factor to apply to the total workgroup count */
@@ -2332,8 +2361,10 @@ export type GetSceneSessions_Session = {
2332
2361
  folder_id: string;
2333
2362
  /** Maximum number of users allowed in this session at the same time */
2334
2363
  max_users: number;
2335
- /** User identifier of the creator of the session */
2364
+ /** @deprecated User identifier of the creator of the session (deprecated, use `created_by` instead) */
2336
2365
  creator_user_id: string;
2366
+ /** User identifier of the creator of the session */
2367
+ created_by?: GetSceneSessions_CreatedBy;
2337
2368
  /** Session creation date */
2338
2369
  created_at: string;
2339
2370
  /** Country code of the rendering server location */
@@ -2345,6 +2376,12 @@ export type GetSceneSessions_Session = {
2345
2376
  /** Current clients in session */
2346
2377
  clients: Array<GetSceneSessions_Client_UserInfo>;
2347
2378
  };
2379
+ export type GetSceneSessions_CreatedBy = {
2380
+ /** User unique identifier */
2381
+ user_id?: string;
2382
+ username?: string;
2383
+ required?: any;
2384
+ };
2348
2385
  export type GetSceneSessions_Client_UserInfo = {
2349
2386
  /** Client unique identifier */
2350
2387
  client_id?: string;
@@ -4200,8 +4237,10 @@ export type GetRunningSessions_Session = {
4200
4237
  folder_id: string;
4201
4238
  /** Maximum number of users allowed in this session at the same time */
4202
4239
  max_users: number;
4203
- /** User identifier of the creator of the session */
4240
+ /** @deprecated User identifier of the creator of the session (deprecated, use `created_by` instead) */
4204
4241
  creator_user_id: string;
4242
+ /** User identifier of the creator of the session */
4243
+ created_by?: GetRunningSessions_CreatedBy;
4205
4244
  /** Session creation date */
4206
4245
  created_at: string;
4207
4246
  /** Country code of the rendering server location */
@@ -4213,6 +4252,12 @@ export type GetRunningSessions_Session = {
4213
4252
  /** Current clients in session */
4214
4253
  clients: Array<GetRunningSessions_Client_UserInfo>;
4215
4254
  };
4255
+ export type GetRunningSessions_CreatedBy = {
4256
+ /** User unique identifier */
4257
+ user_id?: string;
4258
+ username?: string;
4259
+ required?: any;
4260
+ };
4216
4261
  export type GetRunningSessions_Client_UserInfo = {
4217
4262
  /** Client unique identifier */
4218
4263
  client_id?: string;
@@ -4256,8 +4301,10 @@ export type GetSession_Session = {
4256
4301
  folder_id: string;
4257
4302
  /** Maximum number of users allowed in this session at the same time */
4258
4303
  max_users: number;
4259
- /** User identifier of the creator of the session */
4304
+ /** @deprecated User identifier of the creator of the session (deprecated, use `created_by` instead) */
4260
4305
  creator_user_id: string;
4306
+ /** User identifier of the creator of the session */
4307
+ created_by?: GetSession_CreatedBy;
4261
4308
  /** Session creation date */
4262
4309
  created_at: string;
4263
4310
  /** Country code of the rendering server location */
@@ -4269,6 +4316,12 @@ export type GetSession_Session = {
4269
4316
  /** Current clients in session */
4270
4317
  clients: Array<GetSession_Client_UserInfo>;
4271
4318
  };
4319
+ export type GetSession_CreatedBy = {
4320
+ /** User unique identifier */
4321
+ user_id?: string;
4322
+ username?: string;
4323
+ required?: any;
4324
+ };
4272
4325
  export type GetSession_Client_UserInfo = {
4273
4326
  /** Client unique identifier */
4274
4327
  client_id?: string;
package/dist/index.js CHANGED
@@ -81,6 +81,7 @@ __export(index_exports, {
81
81
  getSourceFileAssets: () => getSourceFileAssets,
82
82
  getSourceFileDetails: () => getSourceFileDetails,
83
83
  getSourceFilesInFolder: () => getSourceFilesInFolder,
84
+ getSupportedSourceFileFormats: () => getSupportedSourceFileFormats,
84
85
  getUploadTask: () => getUploadTask,
85
86
  getUploadTasks: () => getUploadTasks,
86
87
  getUploadTasksInFolder: () => getUploadTasksInFolder,
@@ -646,6 +647,13 @@ function deleteSourceFiles({
646
647
  headers
647
648
  });
648
649
  }
650
+ function getSupportedSourceFileFormats(headers) {
651
+ return axiosInstance({
652
+ method: "get",
653
+ url: "/source-files/supported-formats",
654
+ headers
655
+ });
656
+ }
649
657
  function downloadSourceFile({
650
658
  source_file_id
651
659
  }, headers, responseType) {
@@ -1348,6 +1356,7 @@ installInterceptors();
1348
1356
  getSourceFileAssets,
1349
1357
  getSourceFileDetails,
1350
1358
  getSourceFilesInFolder,
1359
+ getSupportedSourceFileFormats,
1351
1360
  getUploadTask,
1352
1361
  getUploadTasks,
1353
1362
  getUploadTasksInFolder,