@3dverse/api 0.7.1 → 0.8.0

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.
@@ -314,9 +314,8 @@ export type ListFolderSubFolders_Object = {
314
314
  username: string;
315
315
  registered_at: string;
316
316
  };
317
- export declare function listFolderSubFolders({ folder_id, depth }: {
317
+ export declare function listFolderSubFolders({ folder_id }: {
318
318
  folder_id: string;
319
- depth?: number;
320
319
  }): AxiosPromise<Array<ListFolderSubFolders_Folder>>;
321
320
  export type UploadSourceFiles_Object = {
322
321
  upload_task_id?: string;
@@ -441,6 +440,24 @@ export declare function moveAssets({ folder_id, asset_ids }: {
441
440
  folder_id: string;
442
441
  asset_ids: Array<string>;
443
442
  }): Promise<import("axios").AxiosResponse<any, any>>;
443
+ export type CreateMaterial_Object = {
444
+ asset_id: string;
445
+ };
446
+ export declare function createMaterial({ folder_id, dataJson, isDoubleSided, name, shaderRef }: {
447
+ folder_id: string;
448
+ dataJson: object;
449
+ isDoubleSided: boolean;
450
+ name: string;
451
+ shaderRef: string;
452
+ }): AxiosPromise<CreateMaterial_Object>;
453
+ export type CreateCubemap_Object = {
454
+ asset_id: string;
455
+ };
456
+ export declare function createCubemap({ folder_id, faces, name }: {
457
+ folder_id: string;
458
+ faces: Array<string>;
459
+ name: string;
460
+ }): AxiosPromise<CreateCubemap_Object>;
444
461
  export type GetSessionsInFolder_Session = {
445
462
  session_id: string;
446
463
  scene_id: string;
@@ -662,7 +679,8 @@ export declare function getAssetFolder({ asset_container, asset_id }: {
662
679
  asset_id: string;
663
680
  }): AxiosPromise<GetAssetFolder_Folder>;
664
681
  export type GetAssetDependencies_Filter = {
665
- asset_type?: "action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material";
682
+ with_asset_types?: Array<"action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material">;
683
+ without_asset_types?: Array<"action_map" | "algorithm" | "animation" | "animation_graph" | "animation_sequence" | "animation_set" | "collision_geometry" | "cubemap" | "event_map" | "material" | "mesh" | "module" | "point_cloud" | "render_graph" | "scene" | "script" | "shader" | "skeleton" | "sound" | "texture" | "texture_1d" | "texture_3d" | "volume_material">;
666
684
  public?: StrictUnion<'include' | 'exclude' | 'restrict-to'>;
667
685
  };
668
686
  export type GetAssetDependencies_Asset = {
@@ -675,8 +693,13 @@ export type GetAssetDependencies_Object = {
675
693
  direct_count?: number;
676
694
  indirect_count?: number;
677
695
  is_public?: boolean;
696
+ payload_info?: GetAssetDependencies_PayloadInfo;
678
697
  dependencies?: Array<GetAssetDependencies_Dependency>;
679
698
  };
699
+ export type GetAssetDependencies_PayloadInfo = {
700
+ hash?: string;
701
+ storage_id?: number;
702
+ };
680
703
  export type GetAssetDependencies_Dependency = {
681
704
  asset_id: string;
682
705
  count: number;
@@ -688,7 +711,7 @@ export declare function getAssetDependencies({ asset_container, asset_id, offset
688
711
  limit?: number;
689
712
  depth?: ('all' | 'direct' | number);
690
713
  filters?: GetAssetDependencies_Filter;
691
- properties?: Array<StrictUnion<'name' | 'dependencies' | 'count' | 'public'>>;
714
+ properties?: Array<StrictUnion<'name' | 'dependencies' | 'count' | 'public' | 'payload_info'>>;
692
715
  }): AxiosPromise<Array<GetAssetDependencies_Asset>>;
693
716
  export type GetAssetReferences_Asset = {
694
717
  asset_id: string;
@@ -709,56 +732,76 @@ export declare function getAssetReferences({ asset_container, asset_id, offset,
709
732
  }): AxiosPromise<Array<GetAssetReferences_Asset>>;
710
733
  export type GetAssetDescription_ActionMap = {
711
734
  actions: GetAssetDescription_Object;
735
+ name: string;
736
+ uuid: string;
712
737
  };
713
738
  export type GetAssetDescription_Object = {
714
739
  [action_name: string]: object;
715
740
  };
716
741
  export type GetAssetDescription_Algorithm = {
717
742
  inputDescriptor: Array<object>;
743
+ name: string;
718
744
  outputDescriptor: Array<object>;
745
+ uuid: string;
719
746
  };
720
747
  export type GetAssetDescription_Animation = {
721
748
  animationEventTrack: GetAssetDescription_Object;
722
749
  durationInMs: number;
750
+ name: string;
723
751
  payloadSize: number;
724
752
  skeletonRef?: string;
753
+ uuid: string;
725
754
  };
726
755
  export type GetAssetDescription_AnimationGraph = {
727
- inputDescriptor: object;
756
+ inputDescriptor: Array<object>;
757
+ name: string;
728
758
  stateMachines: Array<GetAssetDescription_Object>;
759
+ uuid: string;
729
760
  };
730
761
  export type GetAssetDescription_AnimationSequence = {
731
- inputDescriptor: object;
762
+ durationInMs: number;
763
+ name: string;
764
+ uuid: string;
732
765
  };
733
766
  export type GetAssetDescription_AnimationSet = {
734
767
  animationGraphUUID: string;
735
- animationSet: GetAssetDescription_Object;
768
+ animationSet: Array<GetAssetDescription_Object>;
769
+ name: string;
770
+ uuid: string;
736
771
  };
737
772
  export type GetAssetDescription_CollisionGeometry = {
738
773
  geometryType: StrictUnion<0 | 1>;
774
+ name: string;
739
775
  payloadSize: number;
776
+ uuid: string;
740
777
  };
741
778
  export type GetAssetDescription_Cubemap = {
742
779
  faces: Array<string>;
780
+ name: string;
781
+ uuid: string;
743
782
  };
744
783
  export type GetAssetDescription_EventMap = {
745
- eventDescriptors: GetAssetDescription_Object;
784
+ events: GetAssetDescription_Object;
785
+ name: string;
786
+ uuid: string;
746
787
  };
747
788
  export type GetAssetDescription_Material = {
748
789
  dataJson: object;
749
790
  isDoubleSided: boolean;
791
+ name: string;
750
792
  shaderRef: string;
751
- skinnedShaderRef: string;
793
+ uuid: string;
752
794
  };
753
795
  export type GetAssetDescription_Mesh = {
796
+ name: string;
754
797
  payloadSize: number;
755
798
  submeshes: Array<GetAssetDescription_Submesh>;
799
+ uuid: string;
756
800
  };
757
801
  export type GetAssetDescription_Submesh = {
758
- boundingBox: GetAssetDescription_BoundingBox;
802
+ aabb: GetAssetDescription_BoundingBox;
759
803
  channels: Array<GetAssetDescription_Channel>;
760
804
  indexCount: number;
761
- payloadSize: number;
762
805
  vertexCount: number;
763
806
  };
764
807
  export type GetAssetDescription_BoundingBox = {
@@ -771,24 +814,42 @@ export type GetAssetDescription_Channel = {
771
814
  elementCount: number;
772
815
  elementSize: number;
773
816
  elementType: StrictUnion<0 | 1 | 2> & number;
774
- semantic: "invalid" | "index" | "position" | "normal" | "uv" | "color" | "bone_id" | "weight";
817
+ semantic: StrictUnion<0 | 1 | 2 | 3 | 4 | 5 | 6 | 7> & number;
775
818
  };
776
819
  export type GetAssetDescription_Module = {
777
820
  functions: GetAssetDescription_Object;
821
+ name: string;
822
+ uuid: string;
778
823
  };
779
824
  export type GetAssetDescription_PointCloud = {
780
- format: "invalid" | "xyz32" | "xyz32_rgb8";
825
+ format: StrictUnion<0 | 1 | 2>;
826
+ name: string;
781
827
  payloadTotalSize: number;
782
828
  pointCount: number;
783
829
  scale?: Array<number>;
784
830
  translation?: Array<number>;
831
+ uuid: string;
832
+ };
833
+ export type GetAssetDescription_RenderGraph = {
834
+ blendStates: Array<GetAssetDescription_Object>;
835
+ defaultRenderTargetIndex?: number;
836
+ graphOrder: Array<Array<number>>;
837
+ inputDescriptor: Array<GetAssetDescription_Object>;
838
+ name: string;
839
+ nodeDataDescriptions: Array<GetAssetDescription_Object>;
840
+ occlusionInputDepthRenderTargetIndex?: number;
841
+ renderPassDescriptions: Array<GetAssetDescription_Object>;
842
+ renderTargetDescriptions: Array<GetAssetDescription_Object>;
843
+ stencilStates: Array<GetAssetDescription_Object>;
844
+ uuid: string;
785
845
  };
786
846
  export type GetAssetDescription_Scene = {
787
847
  aabb: GetAssetDescription_Aabb;
788
- animationSequenceInstances?: Array<GetAssetDescription_Object>;
789
848
  entities: Array<object>;
849
+ name: string;
790
850
  settings?: object;
791
851
  triangleCount: number;
852
+ uuid: string;
792
853
  };
793
854
  export type GetAssetDescription_Aabb = {
794
855
  max: Array<number>;
@@ -796,73 +857,86 @@ export type GetAssetDescription_Aabb = {
796
857
  };
797
858
  export type GetAssetDescription_Script = {
798
859
  eventNames: Array<string>;
799
- inputDescriptor?: object;
860
+ inputDescriptor?: Array<GetAssetDescription_Object>;
861
+ name: string;
800
862
  subScripts?: Array<string>;
863
+ uuid: string;
801
864
  };
802
865
  export type GetAssetDescription_Shader = {
803
- blendMode?: "invalid" | "opaque" | "alpha_blended" | "masked";
866
+ blendMode?: StrictUnion<0 | 1 | 2 | 3>;
804
867
  localGroupCount?: Array<number>;
805
- materialDescriptor?: object;
868
+ materialDescriptor?: Array<GetAssetDescription_Object>;
806
869
  moduleDescriptions?: Array<GetAssetDescription_Object>;
807
- nodeDataDescriptor?: object;
870
+ name: string;
871
+ nodeDataDescriptor?: Array<GetAssetDescription_Object>;
808
872
  optGlobalGroupMultiplier?: Array<number>;
809
- optGlobalGroupReference?: "render_target_automatic_split" | "render_target_exact" | "output_render_target_exact" | "instances_buffer" | "point_cloud_input_buffer";
873
+ optGlobalGroupReference?: StrictUnion<0 | 1 | 2 | 3 | 4>;
810
874
  payloadSize: number;
811
875
  shaderStages?: number;
876
+ uuid: string;
812
877
  vertexDescriptor?: Array<GetAssetDescription_Object>;
813
878
  };
814
879
  export type GetAssetDescription_Skeleton = {
815
880
  bones: Array<GetAssetDescription_Object>;
881
+ name: string;
816
882
  payloadSize: number;
883
+ uuid: string;
817
884
  };
818
885
  export type GetAssetDescription_Sound = {
819
886
  bitDepth: number;
820
887
  channelCount: number;
821
888
  durationInMs: number;
889
+ name: string;
822
890
  payloadSize: number;
823
891
  sampleCount: number;
824
892
  sampleFrequencyInHz: number;
893
+ uuid: string;
825
894
  };
826
895
  export type GetAssetDescription_Texture = {
827
- format: "invalid" | "r8s" | "r8u" | "r16s" | "r16u" | "bc1" | "bc1a" | "bc2" | "bc3" | "bc3n" | "bc4" | "bc5" | "bc6" | "bc7" | "rgba8";
896
+ format: StrictUnion<0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14> & any;
828
897
  mips: Array<GetAssetDescription_Object>;
898
+ name: string;
829
899
  payloadTotalSize: number;
900
+ uuid: string;
830
901
  };
831
902
  export type GetAssetDescription_Texture_1D = {
832
- format: "invalid" | "r8s" | "r8u" | "r16s" | "r16u" | "bc1" | "bc1a" | "bc2" | "bc3" | "bc3n" | "bc4" | "bc5" | "bc6" | "bc7" | "rgba8";
903
+ format: StrictUnion<0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14> & any;
833
904
  mips: Array<GetAssetDescription_Object>;
905
+ name: string;
834
906
  payloadTotalSize: number;
907
+ uuid: string;
835
908
  };
836
909
  export type GetAssetDescription_Texture_3D = {
837
- format: "invalid" | "r8s" | "r8u" | "r16s" | "r16u" | "bc1" | "bc1a" | "bc2" | "bc3" | "bc3n" | "bc4" | "bc5" | "bc6" | "bc7" | "rgba8";
910
+ format: StrictUnion<0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14> & any;
838
911
  mips: Array<GetAssetDescription_Object>;
912
+ name: string;
839
913
  payloadTotalSize: number;
914
+ uuid: string;
840
915
  voxelDimensions?: Array<number>;
841
916
  };
842
917
  export type GetAssetDescription_VolumeMaterial = {
843
918
  albedoLUT?: Array<GetAssetDescription_Object>;
844
919
  metallicLUT?: Array<GetAssetDescription_Object>;
920
+ name: string;
845
921
  opacityLUT?: Array<GetAssetDescription_Object>;
846
922
  rangeMax: number;
847
923
  rangeMin: number;
848
924
  roughnessLUT?: Array<GetAssetDescription_Object>;
849
- };
850
- export type GetAssetDescription__index_AssetDescription_AssetDescription = {
851
- name: string;
852
925
  uuid: string;
853
926
  };
854
927
  export declare function getAssetDescription({ asset_container, asset_id }: {
855
928
  asset_container: "action_maps" | "algorithms" | "animations" | "animation_graphs" | "animation_sequences" | "animation_sets" | "collision_geometries" | "cubemaps" | "event_maps" | "materials" | "meshes" | "modules" | "point_clouds" | "render_graphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d" | "volume_materials";
856
929
  asset_id: string;
857
- }): AxiosPromise<StrictUnion<GetAssetDescription_ActionMap | GetAssetDescription_Algorithm | GetAssetDescription_Animation | GetAssetDescription_AnimationGraph | GetAssetDescription_AnimationSequence | GetAssetDescription_AnimationSet | GetAssetDescription_CollisionGeometry | GetAssetDescription_Cubemap | GetAssetDescription_EventMap | GetAssetDescription_Material | GetAssetDescription_Mesh | GetAssetDescription_Module | GetAssetDescription_PointCloud | GetAssetDescription_Scene | GetAssetDescription_Script | GetAssetDescription_Shader | GetAssetDescription_Skeleton | GetAssetDescription_Sound | GetAssetDescription_Texture | GetAssetDescription_Texture_1D | GetAssetDescription_Texture_3D | GetAssetDescription_VolumeMaterial> & GetAssetDescription__index_AssetDescription_AssetDescription>;
930
+ }): AxiosPromise<StrictUnion<GetAssetDescription_ActionMap | GetAssetDescription_Algorithm | GetAssetDescription_Animation | GetAssetDescription_AnimationGraph | GetAssetDescription_AnimationSequence | GetAssetDescription_AnimationSet | GetAssetDescription_CollisionGeometry | GetAssetDescription_Cubemap | GetAssetDescription_EventMap | GetAssetDescription_Material | GetAssetDescription_Mesh | GetAssetDescription_Module | GetAssetDescription_PointCloud | GetAssetDescription_RenderGraph | GetAssetDescription_Scene | GetAssetDescription_Script | GetAssetDescription_Shader | GetAssetDescription_Skeleton | GetAssetDescription_Sound | GetAssetDescription_Texture | GetAssetDescription_Texture_1D | GetAssetDescription_Texture_3D | GetAssetDescription_VolumeMaterial>>;
858
931
  export declare function renameAsset({ asset_container, asset_id, name }: {
859
932
  asset_container: "action_maps" | "algorithms" | "animations" | "animation_graphs" | "animation_sequences" | "animation_sets" | "collision_geometries" | "cubemaps" | "event_maps" | "materials" | "meshes" | "modules" | "point_clouds" | "render_graphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d" | "volume_materials";
860
933
  asset_id: string;
861
934
  name?: string;
862
935
  }): Promise<import("axios").AxiosResponse<any, any>>;
863
- export declare function getAssetPayload({ asset_container_with_payload, asset_id }: {
936
+ export declare function getAssetPayload({ asset_container_with_payload, asset_id, sub_resource }: {
864
937
  asset_container_with_payload: "animations" | "animation_sequences" | "collision_geometries" | "meshes" | "point_clouds" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d";
865
938
  asset_id: string;
939
+ sub_resource?: StrictUnion<string | 'histogram' | 'position' | 'color'>;
866
940
  }): AxiosPromise<ArrayBuffer>;
867
941
  export declare function getAssetHistory({ asset_container, asset_id }: {
868
942
  asset_container: "action_maps" | "algorithms" | "animations" | "animation_graphs" | "animation_sequences" | "animation_sets" | "collision_geometries" | "cubemaps" | "event_maps" | "materials" | "meshes" | "modules" | "point_clouds" | "render_graphs" | "scenes" | "scripts" | "shaders" | "skeletons" | "sounds" | "textures" | "textures_1d" | "textures_3d" | "volume_materials";
@@ -1633,6 +1707,9 @@ export declare function deleteEntity({ scene_id, entity_id }: {
1633
1707
  scene_id: string;
1634
1708
  entity_id: string;
1635
1709
  }): Promise<import("axios").AxiosResponse<any, any>>;
1710
+ export declare function getSceneSettings({ scene_id }: {
1711
+ scene_id: string;
1712
+ }): AxiosPromise<object>;
1636
1713
  export type GetRunningSessions_Filter = {
1637
1714
  user_id?: string;
1638
1715
  scene_id?: string;
package/dist/index.js CHANGED
@@ -33,8 +33,10 @@ __export(library_exports, {
33
33
  UnexpectedServiceError: () => UnexpectedServiceError,
34
34
  axiosInstance: () => axiosInstance,
35
35
  createAsset: () => createAsset,
36
+ createCubemap: () => createCubemap,
36
37
  createFolder: () => createFolder,
37
38
  createGroup: () => createGroup,
39
+ createMaterial: () => createMaterial,
38
40
  createSession: () => createSession,
39
41
  createSubfolder: () => createSubfolder,
40
42
  deleteAsset: () => deleteAsset,
@@ -67,6 +69,7 @@ __export(library_exports, {
67
69
  getRunningSessions: () => getRunningSessions,
68
70
  getSceneAABB: () => getSceneAABB,
69
71
  getSceneSessions: () => getSceneSessions,
72
+ getSceneSettings: () => getSceneSettings,
70
73
  getSession: () => getSession,
71
74
  getSessionsInFolder: () => getSessionsInFolder,
72
75
  getSourceFileAssets: () => getSourceFileAssets,
@@ -390,15 +393,11 @@ function createSubfolder({
390
393
  });
391
394
  }
392
395
  function listFolderSubFolders({
393
- folder_id,
394
- depth = 0
396
+ folder_id
395
397
  }) {
396
398
  return axiosInstance({
397
399
  method: "get",
398
- url: "/folders/" + folder_id + "/folders",
399
- params: {
400
- depth
401
- }
400
+ url: "/folders/" + folder_id + "/folders"
402
401
  });
403
402
  }
404
403
  function getSourceFilesInFolder({
@@ -480,6 +479,38 @@ function moveAssets({
480
479
  data: asset_ids
481
480
  });
482
481
  }
482
+ function createMaterial({
483
+ folder_id,
484
+ dataJson,
485
+ isDoubleSided,
486
+ name,
487
+ shaderRef
488
+ }) {
489
+ return axiosInstance({
490
+ method: "post",
491
+ url: "/folders/" + folder_id + "/assets/materials",
492
+ data: {
493
+ dataJson,
494
+ isDoubleSided,
495
+ name,
496
+ shaderRef
497
+ }
498
+ });
499
+ }
500
+ function createCubemap({
501
+ folder_id,
502
+ faces,
503
+ name
504
+ }) {
505
+ return axiosInstance({
506
+ method: "post",
507
+ url: "/folders/" + folder_id + "/assets/cubemaps",
508
+ data: {
509
+ faces,
510
+ name
511
+ }
512
+ });
513
+ }
483
514
  function getSessionsInFolder({
484
515
  folder_id
485
516
  }) {
@@ -699,12 +730,16 @@ function renameAsset({
699
730
  }
700
731
  function getAssetPayload({
701
732
  asset_container_with_payload,
702
- asset_id
733
+ asset_id,
734
+ sub_resource
703
735
  }) {
704
736
  return axiosInstance({
705
737
  method: "get",
706
738
  url: "/assets/" + asset_container_with_payload + "/" + asset_id + "/payload",
707
- responseType: "arraybuffer"
739
+ responseType: "arraybuffer",
740
+ params: {
741
+ sub_resource
742
+ }
708
743
  });
709
744
  }
710
745
  function getAssetHistory({
@@ -849,6 +884,14 @@ function deleteEntity({
849
884
  url: "/assets/scenes/" + scene_id + "/entities/" + entity_id
850
885
  });
851
886
  }
887
+ function getSceneSettings({
888
+ scene_id
889
+ }) {
890
+ return axiosInstance({
891
+ method: "get",
892
+ url: "/assets/scenes/" + scene_id + "/settings"
893
+ });
894
+ }
852
895
  function getRunningSessions({
853
896
  filters
854
897
  }) {
@@ -1023,8 +1066,10 @@ function uploadSourceFiles({
1023
1066
  UnexpectedServiceError,
1024
1067
  axiosInstance,
1025
1068
  createAsset,
1069
+ createCubemap,
1026
1070
  createFolder,
1027
1071
  createGroup,
1072
+ createMaterial,
1028
1073
  createSession,
1029
1074
  createSubfolder,
1030
1075
  deleteAsset,
@@ -1057,6 +1102,7 @@ function uploadSourceFiles({
1057
1102
  getRunningSessions,
1058
1103
  getSceneAABB,
1059
1104
  getSceneSessions,
1105
+ getSceneSettings,
1060
1106
  getSession,
1061
1107
  getSessionsInFolder,
1062
1108
  getSourceFileAssets,