@3dverse/api 0.8.21 → 0.9.0

package/dist/_prebuild/wrapper.d.ts

@@ -195,7 +195,7 @@ export type GetUserUploadTasks_ConversionTask = {
     source_file_id: string;
     /** The name of the source file */
     source_file_name: string;
-    conversion_pipeline: 'auto-detect' | 'volume' | 'scene' | 'texture' | 'animation' | 'point-cloud';
+    conversion_pipeline: 'auto-detect' | 'volume' | 'scene' | 'texture' | 'animation' | 'point-cloud' | 'package';
     progress: number;
     status: StrictUnion<'pending' | 'converting' | 'error' | 'success'> & string;
 };
@@ -508,15 +508,23 @@ export type UploadSourceFiles_Object = {
     upload_task_id?: string;
 };
 /**
- * Uploads the specified source file(s).
- * The supported file formats are:
- *   - Scene :
- *     - 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`
- *     - Point cloud : `e57, ptx, xyz, las, laz`
- *     - Volume : `dcm`
- *   - Texture : `jpg, jpeg, png, tga, dds, tif, tiff, bmp, rgbe`
- *   - Cubemap : `hdr`
- *   - Sound : `wav, mp3, ogg, flac`.
+ * 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.
+ * ### Importing an asset package
+ * With the `package` conversion pipeline, the source files are already converted assets, imported as they are,
+ * submitted as zip archives (asset packages) or as the asset files themselves. The asset files are named
+ * `<part>.<asset_type>[.<sub resource>].<uuid>`, where the part is `desc` (the asset description, in JSON),
+ * `payload`, `graph` or `layout`, for example `desc.mesh.<uuid>`, `payload.mesh.<uuid>` or
+ * `payload.texture.mip0.<uuid>`. The assets they reference must be submitted along with them, unless they already
+ * exist. The submitted assets that already exist are overwritten only if they are listed in an `overwrite.json`
+ * file, a JSON array of asset ids submitted along with them; without it, the import fails if one of them already
+ * exists.
+ * The import runs asynchronously, as a data pipeline:
+ *   1. `GET /pipelines/{pipeline_id}`, with the returned `upload_task_id` as the pipeline id, tells its status and,
+ *      on failure, the reason, such as the invalid assets or the missing permissions.
+ *   2. Once it has succeeded, `GET /conversion_tasks/{conversion_task_id}/metadata/import_result.json`, with the id
+ *      of the pipeline job as the conversion task id, returns the imported, overwritten and skipped asset ids.
  */
 export declare function uploadSourceFiles({ folder_id, body, }: {
     folder_id: string;
@@ -582,7 +590,7 @@ export type GetUploadTasksInFolder_ConversionTask = {
     source_file_id: string;
     /** The name of the source file */
     source_file_name: string;
-    conversion_pipeline: 'auto-detect' | 'volume' | 'scene' | 'texture' | 'animation' | 'point-cloud';
+    conversion_pipeline: 'auto-detect' | 'volume' | 'scene' | 'texture' | 'animation' | 'point-cloud' | 'package';
     progress: number;
     status: StrictUnion<'pending' | 'converting' | 'error' | 'success'> & string;
 };
@@ -726,59 +734,6 @@ export declare function createCubemap({ folder_id, faces, name, }: {
     /** Name of the asset */
     name: string;
 }, headers?: AxiosRequestHeaders): AxiosPromise<CreateCubemap_Object>;
-export type ImportAssets__index_ImportAssetsResponse_ImportAssetsResponse = {
-    /** List of asset ids contained in the package */
-    asset_ids: ImportAssets_AssetIds;
-    /** List of skipped file names in the package */
-    skipped_files?: Array<string>;
-};
-export type ImportAssets_AssetIds = {
-    /** List of asset ids that were created */
-    imported: Array<string>;
-    /** List of asset ids that were overwritten */
-    overwritten: Array<string>;
-    /** List of asset ids that were skipped because they already exist and were not specified in the overwrite.json file */
-    skipped: Array<string>;
-};
-/**
- * Imports or replaces multiple assets submitted as a package.
- * The package must be a zip archive containing the assets to import.
- * The package should contain the assets themselves at the root level of the archive with their descriptions in JSON format, and their payloads (e.g. textures, meshes, etc.)
- * and contain all the assets' dependencies if they do not already exist.
- * Supported assets are :
- *   - scene
- *   - mesh
- *   - material
- *   - animation
- *   - animation_set
- *   - animation_graph
- *   - skeleton
- *   - texture_1d
- *   - texture
- *   - texture_3d
- *   - collision_geometry
- *   - cubemap
- *   - volume_material
- *   - event_map
- *   - action_map
- *   - sound
- *   - point_cloud
- * The packaged assets' files should be named according to the following pattern:
- * ``` json
- * - desc.[asset_type].{uuid}
- * - payload.[mesh|texture|animation|skeleton|texture_1d|texture_3d|collision_geometry|sound].{uuid}
- * - payload.[texture_1d|texture|texture_3d].mips[0-16].{uuid}
- * - payload.point_cloud.[position|color].{uuid}
- * - payload.texture_3d.histogram.{uuid}
- * ```
- * The package may also contain an overwrite.json file that describes which assets to overwrite.
- * The overwrite.json file is only used if the overwrite query parameter is set to only-specified.
- */
-export declare function importAssets({ folder_id, overwrite, body, }: {
-    folder_id: string;
-    overwrite?: 'never' | 'only-specified' | 'always';
-    body: ArrayBuffer | ReadableStream;
-}, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void, headers?: AxiosRequestHeaders): AxiosPromise<ImportAssets__index_ImportAssetsResponse_ImportAssetsResponse>;
 export type GetSessionsInFolder_Session = {
     /** Session unique identifier */
     session_id: string;
@@ -790,8 +745,10 @@ export type GetSessionsInFolder_Session = {
     folder_id: string;
     /** Maximum number of users allowed in this session at the same time */
     max_users: number;
-    /** User identifier of the creator of the session */
+    /** @deprecated User identifier of the creator of the session (deprecated, use `created_by` instead) */
     creator_user_id: string;
+    /** User identifier of the creator of the session */
+    created_by?: GetSessionsInFolder_CreatedBy;
     /** Session creation date */
     created_at: string;
     /** Country code of the rendering server location */
@@ -803,6 +760,12 @@ export type GetSessionsInFolder_Session = {
     /** Current clients in session */
     clients: Array<GetSessionsInFolder_Client_UserInfo>;
 };
+export type GetSessionsInFolder_CreatedBy = {
+    /** User unique identifier */
+    user_id?: string;
+    username?: string;
+    required?: any;
+};
 export type GetSessionsInFolder_Client_UserInfo = {
     /** Client unique identifier */
     client_id?: string;
@@ -849,6 +812,34 @@ export declare function deleteSourceFiles({ source_file_ids, delete_assets, }: {
      */
     delete_assets?: boolean;
 }, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
+export type GetSupportedSourceFileFormats_SupportedSourceFileFormats = {
+    /** Files accepted by one conversion type. Aggregates are the union over its converters. */
+    cubemap: GetSupportedSourceFileFormats_SupportedFormat;
+    /** Files accepted by one conversion type. Aggregates are the union over its converters. */
+    point_cloud: GetSupportedSourceFileFormats_SupportedFormat;
+    /** Files accepted by one conversion type. Aggregates are the union over its converters. */
+    scene: GetSupportedSourceFileFormats_SupportedFormat;
+    /** Files accepted by one conversion type. Aggregates are the union over its converters. */
+    sound: GetSupportedSourceFileFormats_SupportedFormat;
+    /** Files accepted by one conversion type. Aggregates are the union over its converters. */
+    texture: GetSupportedSourceFileFormats_SupportedFormat;
+    /** Files accepted by one conversion type. Aggregates are the union over its converters. */
+    volume: GetSupportedSourceFileFormats_SupportedFormat;
+};
+export type GetSupportedSourceFileFormats_SupportedFormat = {
+    /** Extra file extensions to bundle with a given primary extension. */
+    associated_file_extensions?: GetSupportedSourceFileFormats_Object;
+    /** Per sub-pipeline breakdown, keyed by converter name. */
+    converters: GetSupportedSourceFileFormats_Object;
+    file_extensions: Array<string>;
+};
+export type GetSupportedSourceFileFormats_Object = {
+    [_additionalproperties_: string]: Array<string>;
+};
+/**
+ * Returns the source file formats accepted for conversion, grouped by conversion type, with the per-converter breakdown and each converter's options schema.
+ */
+export declare function getSupportedSourceFileFormats(headers?: AxiosRequestHeaders): AxiosPromise<GetSupportedSourceFileFormats_SupportedSourceFileFormats>;
 /**
  * Downloads the target source file.
  */
@@ -953,7 +944,7 @@ export type GetUploadTask_ConversionTask = {
     source_file_id: string;
     /** The name of the source file */
     source_file_name: string;
-    conversion_pipeline: 'auto-detect' | 'volume' | 'scene' | 'texture' | 'animation' | 'point-cloud';
+    conversion_pipeline: 'auto-detect' | 'volume' | 'scene' | 'texture' | 'animation' | 'point-cloud' | 'package';
     progress: number;
     status: StrictUnion<'pending' | 'converting' | 'error' | 'success'> & string;
 };
@@ -999,6 +990,10 @@ export type GetPipeline_Pipeline = {
     data_pipeline_id: string;
     /** Unique identifier of an environment */
     environment_id: string;
+    /** Reason why the pipeline failed or was rejected, if applicable. */
+    error?: string;
+    /** Stable, machine-readable category for why a pipeline/job/step failed or was rejected. Meant for programmatic handling (e.g. displaying a localized, user-facing message) — the accompanying `error` field carries the technical detail. `processing_failed` is a catch-all used whenever the failure doesn't fall into one of the other, more specific categories. */
+    error_code?: 'quota_exceeded' | 'unsupported_file_format' | 'nothing_to_process' | 'enqueue_failed' | 'download_failed' | 'extraction_failed' | 'processing_failed';
     /** Date and time when the pipeline was completed, either successfully or with errors. */
     finished_at?: string;
     /** Folder unique identifier */
@@ -1019,6 +1014,10 @@ export type GetPipeline_Pipeline = {
     user_id: string;
 };
 export type GetPipeline_Job = {
+    /** Reason why the job failed, if applicable. */
+    error?: string;
+    /** Stable, machine-readable category for why a pipeline/job/step failed or was rejected. Meant for programmatic handling (e.g. displaying a localized, user-facing message) — the accompanying `error` field carries the technical detail. `processing_failed` is a catch-all used whenever the failure doesn't fall into one of the other, more specific categories. */
+    error_code?: 'quota_exceeded' | 'unsupported_file_format' | 'nothing_to_process' | 'enqueue_failed' | 'download_failed' | 'extraction_failed' | 'processing_failed';
     /** Date and time when the job was completed, either successfully or with errors. */
     finished_at?: string;
     /** Data Pipeline job unique identifier. */
@@ -1037,6 +1036,10 @@ export type GetPipeline_Job = {
     steps: Array<GetPipeline_Step>;
 };
 export type GetPipeline_Step = {
+    /** Reason why the step failed, if applicable. */
+    error?: string;
+    /** Stable, machine-readable category for why a pipeline/job/step failed or was rejected. Meant for programmatic handling (e.g. displaying a localized, user-facing message) — the accompanying `error` field carries the technical detail. `processing_failed` is a catch-all used whenever the failure doesn't fall into one of the other, more specific categories. */
+    error_code?: 'quota_exceeded' | 'unsupported_file_format' | 'nothing_to_process' | 'enqueue_failed' | 'download_failed' | 'extraction_failed' | 'processing_failed';
     /** Date and time when the step was completed, either successfully or with errors. */
     finished_at?: string;
     /** Data Pipeline job unique identifier. */
@@ -1776,7 +1779,7 @@ export type GetAssetDescription_Shader = {
 };
 export type GetAssetDescription_ComputeShaderSettings = {
     /** Global group reference */
-    sizeReference?: StrictUnion<0 | 1 | 2>;
+    sizeReference?: StrictUnion<0 | 1 | 2 | 3>;
     /** Size of the workgroup */
     workgroupSize?: Array<number>;
     /** Scaling factor to apply to the total workgroup count */
@@ -2332,8 +2335,10 @@ export type GetSceneSessions_Session = {
     folder_id: string;
     /** Maximum number of users allowed in this session at the same time */
     max_users: number;
-    /** User identifier of the creator of the session */
+    /** @deprecated User identifier of the creator of the session (deprecated, use `created_by` instead) */
     creator_user_id: string;
+    /** User identifier of the creator of the session */
+    created_by?: GetSceneSessions_CreatedBy;
     /** Session creation date */
     created_at: string;
     /** Country code of the rendering server location */
@@ -2345,6 +2350,12 @@ export type GetSceneSessions_Session = {
     /** Current clients in session */
     clients: Array<GetSceneSessions_Client_UserInfo>;
 };
+export type GetSceneSessions_CreatedBy = {
+    /** User unique identifier */
+    user_id?: string;
+    username?: string;
+    required?: any;
+};
 export type GetSceneSessions_Client_UserInfo = {
     /** Client unique identifier */
     client_id?: string;
@@ -4200,8 +4211,10 @@ export type GetRunningSessions_Session = {
     folder_id: string;
     /** Maximum number of users allowed in this session at the same time */
     max_users: number;
-    /** User identifier of the creator of the session */
+    /** @deprecated User identifier of the creator of the session (deprecated, use `created_by` instead) */
     creator_user_id: string;
+    /** User identifier of the creator of the session */
+    created_by?: GetRunningSessions_CreatedBy;
     /** Session creation date */
     created_at: string;
     /** Country code of the rendering server location */
@@ -4213,6 +4226,12 @@ export type GetRunningSessions_Session = {
     /** Current clients in session */
     clients: Array<GetRunningSessions_Client_UserInfo>;
 };
+export type GetRunningSessions_CreatedBy = {
+    /** User unique identifier */
+    user_id?: string;
+    username?: string;
+    required?: any;
+};
 export type GetRunningSessions_Client_UserInfo = {
     /** Client unique identifier */
     client_id?: string;
@@ -4256,8 +4275,10 @@ export type GetSession_Session = {
     folder_id: string;
     /** Maximum number of users allowed in this session at the same time */
     max_users: number;
-    /** User identifier of the creator of the session */
+    /** @deprecated User identifier of the creator of the session (deprecated, use `created_by` instead) */
     creator_user_id: string;
+    /** User identifier of the creator of the session */
+    created_by?: GetSession_CreatedBy;
     /** Session creation date */
     created_at: string;
     /** Country code of the rendering server location */
@@ -4269,6 +4290,12 @@ export type GetSession_Session = {
     /** Current clients in session */
     clients: Array<GetSession_Client_UserInfo>;
 };
+export type GetSession_CreatedBy = {
+    /** User unique identifier */
+    user_id?: string;
+    username?: string;
+    required?: any;
+};
 export type GetSession_Client_UserInfo = {
     /** Client unique identifier */
     client_id?: string;

package/dist/index.js

@@ -81,6 +81,7 @@ __export(index_exports, {
   getSourceFileAssets: () => getSourceFileAssets,
   getSourceFileDetails: () => getSourceFileDetails,
   getSourceFilesInFolder: () => getSourceFilesInFolder,
+  getSupportedSourceFileFormats: () => getSupportedSourceFileFormats,
   getUploadTask: () => getUploadTask,
   getUploadTasks: () => getUploadTasks,
   getUploadTasksInFolder: () => getUploadTasksInFolder,
@@ -89,7 +90,6 @@ __export(index_exports, {
   getUserUploadTasks: () => getUserUploadTasks,
   grantMemberAccessToFolder: () => grantMemberAccessToFolder,
   grantMemberAccessToGroup: () => grantMemberAccessToGroup,
-  importAssets: () => importAssets,
   joinSession: () => joinSession,
   joinSessionAsGuest: () => joinSessionAsGuest,
   kickClientFromSession: () => kickClientFromSession,
@@ -584,26 +584,6 @@ function createCubemap({
     headers
   });
 }
-function importAssets({
-  folder_id,
-  overwrite = "never",
-  body
-}, onUploadProgress, headers) {
-  return axiosInstance({
-    method: "put",
-    url: "/folders/" + folder_id + "/packages",
-    params: {
-      overwrite
-    },
-    data: body,
-    maxRedirects: 0,
-    onUploadProgress,
-    headers: {
-      "Content-Type": "application/zip",
-      ...headers?.toJSON()
-    }
-  });
-}
 function getSessionsInFolder({
   folder_id
 }, headers) {
@@ -646,6 +626,13 @@ function deleteSourceFiles({
     headers
   });
 }
+function getSupportedSourceFileFormats(headers) {
+  return axiosInstance({
+    method: "get",
+    url: "/source-files/supported-formats",
+    headers
+  });
+}
 function downloadSourceFile({
   source_file_id
 }, headers, responseType) {
@@ -1348,6 +1335,7 @@ installInterceptors();
   getSourceFileAssets,
   getSourceFileDetails,
   getSourceFilesInFolder,
+  getSupportedSourceFileFormats,
   getUploadTask,
   getUploadTasks,
   getUploadTasksInFolder,
@@ -1356,7 +1344,6 @@ installInterceptors();
   getUserUploadTasks,
   grantMemberAccessToFolder,
   grantMemberAccessToGroup,
-  importAssets,
   joinSession,
   joinSessionAsGuest,
   kickClientFromSession,