@realsee/five 6.8.0-alpha.0 → 6.8.0-alpha.10

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.
Files changed (775) hide show
  1. package/AGENTS_READ_ME.md +4 -0
  2. package/AI_CONTEXT.md +4 -0
  3. package/README.md +50 -389
  4. package/ai_guides/README.md +122 -0
  5. package/ai_guides/ai-doc-guidelines.md +102 -0
  6. package/ai_guides/api.md +274 -0
  7. package/ai_guides/features/3dtile.md +172 -0
  8. package/ai_guides/features/camera-animation.md +205 -0
  9. package/ai_guides/features/clipper.md +135 -0
  10. package/ai_guides/features/coordinate-system.md +128 -0
  11. package/ai_guides/features/event.md +154 -0
  12. package/ai_guides/features/five.md +184 -0
  13. package/ai_guides/features/flowing-light-2d-pass.md +438 -0
  14. package/ai_guides/features/flowing-light-3d-pass.md +420 -0
  15. package/ai_guides/features/gaussian-blur-pass.md +202 -0
  16. package/ai_guides/features/gesture.md +180 -0
  17. package/ai_guides/features/get-screen-pixels.md +182 -0
  18. package/ai_guides/features/image-options.md +164 -0
  19. package/ai_guides/features/load-external-model.md +350 -0
  20. package/ai_guides/features/load-progress.md +140 -0
  21. package/ai_guides/features/material.md +151 -0
  22. package/ai_guides/features/mode.md +269 -0
  23. package/ai_guides/features/model.md +186 -0
  24. package/ai_guides/features/move-pano-effect.md +145 -0
  25. package/ai_guides/features/multi-work.md +146 -0
  26. package/ai_guides/features/pano-tile.md +132 -0
  27. package/ai_guides/features/pano-uv.md +131 -0
  28. package/ai_guides/features/parameter.md +153 -0
  29. package/ai_guides/features/plugin.md +210 -0
  30. package/ai_guides/features/postprocessing.md +259 -0
  31. package/ai_guides/features/raycast.md +175 -0
  32. package/ai_guides/features/request-proxy.md +112 -0
  33. package/ai_guides/features/screen-project.md +165 -0
  34. package/ai_guides/features/state.md +101 -0
  35. package/ai_guides/features/view-layer.md +187 -0
  36. package/ai_guides/features/work.md +303 -0
  37. package/ai_guides/glossary.md +93 -0
  38. package/ai_guides/intro.md +23 -0
  39. package/ai_guides/quick-start.md +69 -0
  40. package/ai_guides/release_notes/6.6.md +86 -0
  41. package/ai_guides/release_notes/6.7.md +401 -0
  42. package/ai_guides/release_notes/6.8.md +90 -0
  43. package/ai_guides/support.md +23 -0
  44. package/ai_guides/template.md +70 -0
  45. package/docs/00_FOR_AI_AGENTS.md +11 -0
  46. package/docs/README.md +11 -0
  47. package/docs/assets/hierarchy.js +1 -1
  48. package/docs/assets/highlight.css +29 -29
  49. package/docs/assets/icons.js +1 -1
  50. package/docs/assets/icons.svg +1 -1
  51. package/docs/assets/main.js +2 -2
  52. package/docs/assets/navigation.js +1 -1
  53. package/docs/assets/search.js +1 -1
  54. package/docs/assets/style.css +3 -3
  55. package/docs/classes/five.AdaptiveLuminancePass.html +2 -2
  56. package/docs/classes/five.AnimationFrameLoop.html +5 -5
  57. package/docs/classes/five.BoundingMesh.html +1 -1
  58. package/docs/classes/five.Camera.html +5 -5
  59. package/docs/classes/five.EffectComposer.html +1 -1
  60. package/docs/classes/five.EyeDomeLightingPass.html +2 -2
  61. package/docs/classes/five.Five.html +134 -134
  62. package/docs/classes/five.FivePass.html +2 -2
  63. package/docs/classes/five.FullScreenQuad.html +2 -2
  64. package/docs/classes/five.InternalWebGLRenderer.html +1 -1
  65. package/docs/classes/five.Model.html +36 -36
  66. package/docs/classes/five.ModelScene.html +12 -12
  67. package/docs/classes/five.Motion.html +1 -1
  68. package/docs/classes/five.NetworkSubscribe.html +23 -23
  69. package/docs/classes/five.PBMContainer.html +3 -3
  70. package/docs/classes/five.PBMGSObject.html +24 -0
  71. package/docs/classes/five.PBMGroup.html +1 -1
  72. package/docs/classes/five.PBMMesh.html +1 -1
  73. package/docs/classes/five.PBMMeshMaterial.html +15 -6
  74. package/docs/classes/five.PBMPointCloud.html +1 -1
  75. package/docs/classes/five.PBMPointCloudMaterial.html +3 -3
  76. package/docs/classes/five.PBMSkinnedMesh.html +1 -1
  77. package/docs/classes/five.PanoCircleMesh.html +4 -4
  78. package/docs/classes/five.PanoCircleMeshCustom.html +4 -4
  79. package/docs/classes/five.PanoCircleMeshSolid.html +4 -4
  80. package/docs/classes/five.Parameter.html +55 -51
  81. package/docs/classes/five.Scene.html +3 -3
  82. package/docs/classes/five.Subscribe.html +26 -25
  83. package/docs/classes/five.Tile.html +1 -1
  84. package/docs/classes/five.Tile3D.html +30 -26
  85. package/docs/classes/five.TileNode.html +2 -2
  86. package/docs/classes/five.Tileset.html +11 -11
  87. package/docs/classes/five.Trajectory.html +1 -1
  88. package/docs/classes/five.TrajectoryNode.html +1 -1
  89. package/docs/classes/five.Work.html +19 -19
  90. package/docs/classes/five.WorkResolvedObserver.html +41 -16
  91. package/docs/classes/gltf-loader.DDSLoader.html +1 -1
  92. package/docs/classes/gltf-loader.DRACOLoader.html +1 -1
  93. package/docs/classes/gltf-loader.GLTFLoader.html +6 -6
  94. package/docs/classes/gltf-loader.GLTFObject.html +1 -1
  95. package/docs/classes/gltf-loader.THREEGLTFLoader.html +1 -1
  96. package/docs/classes/line.Line.html +1 -1
  97. package/docs/classes/line.LineGeometry.html +4 -4
  98. package/docs/classes/line.LineMaterial.html +1 -1
  99. package/docs/classes/line.LineSegmentsGeometry.html +4 -4
  100. package/docs/classes/line.THREE_Line2.html +1 -1
  101. package/docs/classes/line.THREE_LineSegments2.html +1 -1
  102. package/docs/classes/plugins.BasePlugin.Controller.html +16 -16
  103. package/docs/classes/plugins.RoundedBoxGeometry.html +1 -1
  104. package/docs/classes/react.Store.html +12 -11
  105. package/docs/classes/sticker.Sticker.html +11 -11
  106. package/docs/classes/vfx.Airflow.html +1 -1
  107. package/docs/classes/vfx.Flame.html +1 -1
  108. package/docs/classes/vfx.Particle.html +31 -31
  109. package/docs/classes/vfx.ParticleGPU.html +7 -7
  110. package/docs/classes/vfx.SpotLight.html +1 -1
  111. package/docs/documents/README.html +138 -0
  112. package/docs/documents/ai-doc-guidelines.html +117 -0
  113. package/docs/documents/api.html +337 -0
  114. package/docs/documents/features_3dtile.html +216 -0
  115. package/docs/documents/features_camera-animation.html +157 -0
  116. package/docs/documents/features_clipper.html +80 -0
  117. package/docs/documents/features_coordinate-system.html +127 -0
  118. package/docs/documents/features_event.html +104 -0
  119. package/docs/documents/features_five.html +147 -0
  120. package/docs/documents/features_flowing-light-2d-pass.html +356 -0
  121. package/docs/documents/features_flowing-light-3d-pass.html +351 -0
  122. package/docs/documents/features_gaussian-blur-pass.html +182 -0
  123. package/docs/documents/features_gesture.html +120 -0
  124. package/docs/documents/features_get-screen-pixels.html +88 -0
  125. package/docs/documents/features_image-options.html +108 -0
  126. package/docs/documents/features_load-external-model.html +600 -0
  127. package/docs/documents/features_load-progress.html +110 -0
  128. package/docs/documents/features_material.html +334 -0
  129. package/docs/documents/features_mode.html +114 -0
  130. package/docs/documents/features_model.html +141 -0
  131. package/docs/documents/features_move-pano-effect.html +110 -0
  132. package/docs/documents/features_multi-work.html +97 -0
  133. package/docs/documents/features_pano-tile.html +100 -0
  134. package/docs/documents/features_pano-uv.html +82 -0
  135. package/docs/documents/features_parameter.html +101 -0
  136. package/docs/documents/features_plugin.html +105 -0
  137. package/docs/documents/features_postprocessing.html +109 -0
  138. package/docs/documents/features_raycast.html +98 -0
  139. package/docs/documents/features_request-proxy.html +78 -0
  140. package/docs/documents/features_screen-project.html +112 -0
  141. package/docs/documents/features_state.html +71 -0
  142. package/docs/documents/features_view-layer.html +158 -0
  143. package/docs/documents/features_work.html +129 -0
  144. package/docs/documents/glossary.html +94 -0
  145. package/docs/documents/intro.html +24 -0
  146. package/docs/documents/quick-start.html +32 -0
  147. package/docs/documents/release_notes_6.6.html +79 -0
  148. package/docs/documents/release_notes_6.7.html +209 -0
  149. package/docs/documents/release_notes_6.8.html +103 -0
  150. package/docs/documents/support.html +49 -0
  151. package/docs/documents/template.html +80 -0
  152. package/docs/functions/five.coordinatesToVector.html +1 -1
  153. package/docs/functions/five.defaultImageURLTransform.html +3 -3
  154. package/docs/functions/five.headingToLongitude.html +1 -1
  155. package/docs/functions/five.loadAt3d.html +1 -1
  156. package/docs/functions/five.loadB3dm.html +1 -1
  157. package/docs/functions/five.loadDome.html +1 -1
  158. package/docs/functions/five.loadDomez.html +1 -1
  159. package/docs/functions/five.loadFbx.html +1 -1
  160. package/docs/functions/five.loadGltf.html +1 -1
  161. package/docs/functions/five.loadPbm.html +1 -1
  162. package/docs/functions/five.loadPly.html +1 -1
  163. package/docs/functions/five.loadPnts.html +1 -1
  164. package/docs/functions/five.loadSplat.html +1 -0
  165. package/docs/functions/five.loadSpz.html +1 -0
  166. package/docs/functions/five.loadX3p.html +1 -1
  167. package/docs/functions/five.longitudeToHeading.html +1 -1
  168. package/docs/functions/five.parseWork.html +3 -3
  169. package/docs/functions/five.vectorToCoordinates.html +1 -1
  170. package/docs/functions/react.createFiveProvider.html +2 -2
  171. package/docs/functions/react.createStore.html +8 -8
  172. package/docs/functions/react.useFiveAction.html +6 -6
  173. package/docs/functions/react.useFiveCameraDirection.html +1 -1
  174. package/docs/functions/react.useFiveCameraRaycaster.html +1 -1
  175. package/docs/functions/react.useFiveCurrentObserver.html +1 -1
  176. package/docs/functions/react.useFiveCurrentState.html +1 -1
  177. package/docs/functions/react.useFiveEventCallback.html +1 -1
  178. package/docs/functions/react.useFiveFloor.html +1 -1
  179. package/docs/functions/react.useFiveHelper.html +1 -1
  180. package/docs/functions/react.useFiveModelIntersectRaycaster.html +2 -2
  181. package/docs/functions/react.useFiveModelReadyState.html +1 -1
  182. package/docs/functions/react.useFiveProject2d.html +2 -2
  183. package/docs/functions/react.useFiveSceneEffect.html +1 -1
  184. package/docs/functions/react.useFiveWork.html +2 -2
  185. package/docs/functions/vue.useFiveAction.html +8 -8
  186. package/docs/functions/vue.useFiveCameraDirection.html +1 -1
  187. package/docs/functions/vue.useFiveCameraRaycaster.html +1 -1
  188. package/docs/functions/vue.useFiveCurrentObserver.html +1 -1
  189. package/docs/functions/vue.useFiveCurrentState.html +1 -1
  190. package/docs/functions/vue.useFiveEventCallback.html +1 -1
  191. package/docs/functions/vue.useFiveFloor.html +1 -1
  192. package/docs/functions/vue.useFiveHelper.html +1 -1
  193. package/docs/functions/vue.useFiveModel.html +1 -1
  194. package/docs/functions/vue.useFiveModelBounding.html +1 -1
  195. package/docs/functions/vue.useFiveModelIntersectRaycaster.html +2 -2
  196. package/docs/functions/vue.useFiveModelReadyState.html +1 -1
  197. package/docs/functions/vue.useFiveProject2d.html +2 -2
  198. package/docs/functions/vue.useFiveScene.html +1 -1
  199. package/docs/functions/vue.useFiveState.html +1 -1
  200. package/docs/functions/vue.useFiveWorks.html +4 -4
  201. package/docs/hierarchy.html +1 -1
  202. package/docs/index.html +115 -187
  203. package/docs/interfaces/five.AddableObject.html +5 -5
  204. package/docs/interfaces/five.AjaxOptions.html +5 -5
  205. package/docs/interfaces/five.BaseEvent.html +2 -2
  206. package/docs/interfaces/five.EventCallback.html +198 -194
  207. package/docs/interfaces/five.FiveInitArgs.html +18 -18
  208. package/docs/interfaces/five.FiveLoadOptions.html +3 -3
  209. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +8 -8
  210. package/docs/interfaces/five.GestureEvent.html +2 -2
  211. package/docs/interfaces/five.ImageOptions.html +11 -11
  212. package/docs/interfaces/five.ImageURLOptions.html +8 -8
  213. package/docs/interfaces/five.IntersectEvent.html +2 -2
  214. package/docs/interfaces/five.IntersectMesh.html +1 -1
  215. package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
  216. package/docs/interfaces/five.Intersection.html +4 -3
  217. package/docs/interfaces/five.LooseWorkWithExtrinsics.html +7 -7
  218. package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +8 -8
  219. package/docs/interfaces/five.ModeChangeEvent.html +2 -2
  220. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +9 -9
  221. package/docs/interfaces/five.ModelEvent.html +2 -2
  222. package/docs/interfaces/five.ModelOptions.html +3 -3
  223. package/docs/interfaces/five.ModelSceneEvent.html +2 -2
  224. package/docs/interfaces/five.ModelTileEvent.html +8 -0
  225. package/docs/interfaces/five.MovePanoOptions.html +10 -10
  226. package/docs/interfaces/five.NetworkAbortError.html +1 -1
  227. package/docs/interfaces/five.NetworkFirbiddenError.html +1 -1
  228. package/docs/interfaces/five.NetworkOptions.html +4 -4
  229. package/docs/interfaces/five.NetworkProxyError.html +1 -1
  230. package/docs/interfaces/five.NetworkResourceEvent.html +2 -2
  231. package/docs/interfaces/five.NetworkResponseError.html +1 -1
  232. package/docs/interfaces/five.NetworkTimeoutError.html +1 -1
  233. package/docs/interfaces/five.ObjectEvent.html +2 -2
  234. package/docs/interfaces/five.PBMMaterial.html +1 -1
  235. package/docs/interfaces/five.PBMMeshMaterialParameters.html +1 -1
  236. package/docs/interfaces/five.PBMPanoDepth.html +4 -4
  237. package/docs/interfaces/five.PBMPanoPicture.html +5 -5
  238. package/docs/interfaces/five.PBMPointCloudMaterialParameters.html +1 -1
  239. package/docs/interfaces/five.PanoCircleMeshInterface.html +4 -4
  240. package/docs/interfaces/five.PanoEvent.html +2 -2
  241. package/docs/interfaces/five.PanoTextureEvent.html +2 -2
  242. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +15 -15
  243. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +9 -9
  244. package/docs/interfaces/five.ParameterMaterialValue.html +40 -36
  245. package/docs/interfaces/five.ParameterTilesetValue.html +15 -15
  246. package/docs/interfaces/five.ParameterValue.html +54 -50
  247. package/docs/interfaces/five.Pass.html +1 -1
  248. package/docs/interfaces/five.Pose.html +6 -7
  249. package/docs/interfaces/five.RenderEvent.html +2 -2
  250. package/docs/interfaces/five.ResolvedParameterValue.html +54 -50
  251. package/docs/interfaces/five.SplatData.html +10 -0
  252. package/docs/interfaces/five.State.html +9 -9
  253. package/docs/interfaces/five.StateEvent.html +2 -2
  254. package/docs/interfaces/five.TextureOptions.html +12 -12
  255. package/docs/interfaces/five.Tile3DOptions.html +2 -2
  256. package/docs/interfaces/five.TileCoordinateSystem.html +2 -2
  257. package/docs/interfaces/five.TilesetHeader.html +12 -12
  258. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +7 -7
  259. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +13 -13
  260. package/docs/interfaces/five.ViewLayer.html +30 -26
  261. package/docs/interfaces/five.Viewport.html +4 -4
  262. package/docs/interfaces/five.WorkCubeImage.html +1 -1
  263. package/docs/interfaces/five.WorkImage.html +4 -4
  264. package/docs/interfaces/five.WorkInitial.html +8 -8
  265. package/docs/interfaces/five.WorkModel.html +8 -8
  266. package/docs/interfaces/five.WorkModelLayer.html +6 -6
  267. package/docs/interfaces/five.WorkObserver.html +41 -16
  268. package/docs/interfaces/five.WorkTile.html +4 -4
  269. package/docs/interfaces/five.WorkVideo.html +4 -4
  270. package/docs/interfaces/five.WorksEvent.html +2 -2
  271. package/docs/interfaces/five.XRControllerEvent.html +2 -2
  272. package/docs/interfaces/five.XRGestureEvent.html +2 -2
  273. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +13 -13
  274. package/docs/interfaces/five.XRSessionEvent.html +2 -2
  275. package/docs/interfaces/plugins.BackgroundPluginController.html +11 -11
  276. package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +8 -8
  277. package/docs/interfaces/plugins.BasePlugin.BaseOptions.html +1 -1
  278. package/docs/interfaces/plugins.BasePlugin.Config.html +2 -2
  279. package/docs/interfaces/plugins.BasePlugin.State.html +4 -4
  280. package/docs/interfaces/plugins.BasePlugin.StateChangeParams.html +3 -3
  281. package/docs/interfaces/plugins.DynamicPathLinePluginController.html +45 -45
  282. package/docs/interfaces/plugins.DynamicPathLinePluginType.Config.html +18 -18
  283. package/docs/interfaces/plugins.DynamicPathLinePluginType.EventMap.html +13 -13
  284. package/docs/interfaces/plugins.DynamicPathLinePluginType.Params.html +2 -2
  285. package/docs/interfaces/plugins.DynamicPathLinePluginType.PathConfig.html +14 -14
  286. package/docs/interfaces/plugins.DynamicPathLinePluginType.State.html +5 -5
  287. package/docs/interfaces/plugins.ItemMaskController.html +12 -12
  288. package/docs/interfaces/plugins.ItemMaskPluginType.Config.html +1 -1
  289. package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +5 -5
  290. package/docs/interfaces/plugins.ItemMaskPluginType.Params.html +1 -1
  291. package/docs/interfaces/plugins.ItemMaskPluginType.State.html +7 -7
  292. package/docs/interfaces/plugins.OrientationPluginController.html +12 -12
  293. package/docs/interfaces/plugins.OrientationPluginType.Config.html +1 -1
  294. package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +5 -5
  295. package/docs/interfaces/plugins.OrientationPluginType.Params.html +1 -1
  296. package/docs/interfaces/plugins.OrientationPluginType.State.html +5 -5
  297. package/docs/interfaces/plugins.PanoAnimeController.html +14 -14
  298. package/docs/interfaces/plugins.PanoAnimePluginType.Config.html +1 -1
  299. package/docs/interfaces/plugins.PanoAnimePluginType.ConfigChangeEvent.html +3 -3
  300. package/docs/interfaces/plugins.PanoAnimePluginType.EventMap.html +6 -6
  301. package/docs/interfaces/plugins.PanoAnimePluginType.Params.html +1 -1
  302. package/docs/interfaces/plugins.PanoAnimePluginType.State.html +4 -4
  303. package/docs/interfaces/plugins.PluginTemplateType.Config.html +1 -1
  304. package/docs/interfaces/plugins.PluginTemplateType.EventMap.html +5 -5
  305. package/docs/interfaces/plugins.PluginTemplateType.Params.html +1 -1
  306. package/docs/interfaces/plugins.PluginTemplateType.State.html +4 -4
  307. package/docs/interfaces/plugins.TrajectoryController.html +30 -15
  308. package/docs/interfaces/react.FiveActionReactCallbacks.html +23 -23
  309. package/docs/interfaces/react.FiveCanvasProps.html +2 -2
  310. package/docs/interfaces/react.FiveInjectionTypes.html +76 -76
  311. package/docs/interfaces/sticker.IntersectionLike.html +2 -2
  312. package/docs/interfaces/vfx.ParticleArgs.html +26 -26
  313. package/docs/interfaces/vfx.ParticleGPUArgs.html +30 -30
  314. package/docs/interfaces/vue.FiveActionVueCallbacks.html +23 -23
  315. package/docs/modules/five.html +1 -1
  316. package/docs/modules.html +1 -1
  317. package/docs/types/five.ControllerEventTypes.html +32 -32
  318. package/docs/types/five.EventTypes.html +26 -24
  319. package/docs/types/five.FivePlugin.html +2 -2
  320. package/docs/types/five.FivePluginInit.html +1 -1
  321. package/docs/types/five.FivePluginInstance.html +1 -1
  322. package/docs/types/five.LegacyEventType.html +142 -142
  323. package/docs/types/five.LoadResultType.html +2 -2
  324. package/docs/types/five.Mode.html +1 -1
  325. package/docs/types/five.MotionCircle.html +1 -1
  326. package/docs/types/five.NetworkProgressCallback.html +1 -1
  327. package/docs/types/five.ParseOptions.html +6 -6
  328. package/docs/types/plugins.BasePlugin.EventMap.html +5 -5
  329. package/docs/types/plugins.DynamicPathLinePluginType.PluginData.html +1 -1
  330. package/docs/types/plugins.DynamicPathLinePluginType.ServerData.html +1 -1
  331. package/docs/variables/react.FiveCanvas.html +1 -1
  332. package/docs/variables/react.useFiveScene.html +1 -1
  333. package/docs/variables/vue.FiveCanvas.html +1 -1
  334. package/docs/variables/vue.FiveProvider.html +1 -1
  335. package/five/application/analysis.d.ts +40 -0
  336. package/five/application/controllers.d.ts +41 -0
  337. package/five/application/events-legacy.d.ts +454 -0
  338. package/five/application/events.d.ts +69 -0
  339. package/five/application/five.d.ts +518 -0
  340. package/five/application/fiveInitArgs.d.ts +176 -0
  341. package/five/application/fiveLoadOptions.d.ts +21 -0
  342. package/five/application/generateDefaultVideoElement.d.ts +2 -0
  343. package/five/application/getViewportScale.d.ts +2 -0
  344. package/five/application/initLights.d.ts +3 -0
  345. package/five/application/mode.d.ts +28 -0
  346. package/five/application/renderPoweredByRealsee.d.ts +3 -0
  347. package/five/assets/cardboard-png-data-url.d.ts +2 -0
  348. package/five/assets/gradient-png-data-url.d.ts +2 -0
  349. package/five/assets/loading-png-data-url.d.ts +2 -0
  350. package/five/assets/phone-png-data-url.d.ts +2 -0
  351. package/five/assets/realsee-pmg-data-url.d.ts +2 -0
  352. package/five/bvh/bvhMath.d.ts +33 -0
  353. package/five/bvh/bvhMesh.d.ts +7 -0
  354. package/five/bvh/bvhNode.d.ts +29 -0
  355. package/five/bvh/bvhObject.d.ts +18 -0
  356. package/five/bvh/bvhPoints.d.ts +6 -0
  357. package/five/bvh/index.d.ts +10 -0
  358. package/five/bvh/worker.d.ts +35 -0
  359. package/five/cardboard/helper.d.ts +2 -0
  360. package/five/cardboard/index.d.ts +13 -0
  361. package/five/cardboard/sensor.d.ts +158 -0
  362. package/five/certificates/hardware.d.ts +1 -0
  363. package/five/controllers/base.d.ts +166 -0
  364. package/five/controllers/events.d.ts +69 -0
  365. package/five/controllers/floorplan.d.ts +119 -0
  366. package/five/controllers/mapview.d.ts +138 -0
  367. package/five/controllers/model.d.ts +57 -0
  368. package/five/controllers/panorama.d.ts +143 -0
  369. package/five/controllers/panoramaLike.d.ts +87 -0
  370. package/five/controllers/topview.d.ts +42 -0
  371. package/five/controllers/vrPanorama.d.ts +56 -0
  372. package/five/controllers/xrPanorama.d.ts +81 -0
  373. package/five/core/camera.d.ts +65 -0
  374. package/five/core/internalWebGLRenderer.d.ts +14 -0
  375. package/five/core/panoVideo.d.ts +18 -0
  376. package/five/core/scene.d.ts +10 -0
  377. package/five/core/tiling.d.ts +43 -0
  378. package/five/declare.d.ts +2 -1
  379. package/five/gs/util/renderData.d.ts +32 -0
  380. package/five/gs/wasm/data.d.ts +20 -0
  381. package/five/gs/wasm/sort.d.ts +18 -0
  382. package/five/gs/worker/dataWorker.d.ts +1 -0
  383. package/five/gs/worker/sortWorker.d.ts +1 -0
  384. package/five/index.d.ts +57 -4582
  385. package/five/index.js +605 -92
  386. package/five/index.mjs +9661 -7537
  387. package/five/meshes/boundingMesh.d.ts +12 -0
  388. package/five/meshes/intersectMesh.d.ts +8 -0
  389. package/five/meshes/panoCircleMesh.d.ts +35 -0
  390. package/five/meshes/panoCircleMeshCustom.d.ts +40 -0
  391. package/five/meshes/panoCircleMeshSolid.d.ts +34 -0
  392. package/five/meshes/panoSphereMesh.d.ts +27 -0
  393. package/five/model/helpers/coordinate-transform.d.ts +3 -0
  394. package/five/model/helpers/ellipsoid-coordinates.d.ts +14 -0
  395. package/five/model/helpers/get-edges-by-sphere.d.ts +8 -0
  396. package/five/model/helpers/get-recommend-tile3d-parameters.d.ts +8 -0
  397. package/five/model/index.d.ts +70 -0
  398. package/five/model/intersection.d.ts +18 -0
  399. package/five/model/loaders/at3d.d.ts +12 -0
  400. package/five/model/loaders/b3dm.d.ts +9 -0
  401. package/five/model/loaders/dome.d.ts +22 -0
  402. package/five/model/loaders/domez.d.ts +11 -0
  403. package/five/model/loaders/fbx.d.ts +8 -0
  404. package/five/model/loaders/glTF-helpers/extensions/CESIUM_RTC.d.ts +9 -0
  405. package/five/model/loaders/glTF-helpers/extensions/EXT_meshopt_compression.d.ts +8 -0
  406. package/five/model/loaders/glTF-helpers/extensions/EXT_texture_webp.d.ts +11 -0
  407. package/five/model/loaders/glTF-helpers/extensions/KHR_animation_pointer.d.ts +6 -0
  408. package/five/model/loaders/glTF-helpers/extensions/KHR_binary_glTF.d.ts +25 -0
  409. package/five/model/loaders/glTF-helpers/extensions/KHR_draco_mesh_compression.d.ts +11 -0
  410. package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz.d.ts +9 -0
  411. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_clearcoat.d.ts +10 -0
  412. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_emissive_strength.d.ts +10 -0
  413. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_sheen.d.ts +10 -0
  414. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_transmission.d.ts +10 -0
  415. package/five/model/loaders/glTF-helpers/extensions/KHR_materials_unlit.d.ts +10 -0
  416. package/five/model/loaders/glTF-helpers/extensions/KHR_mesh_quantization.d.ts +6 -0
  417. package/five/model/loaders/glTF-helpers/extensions/KHR_node_visibility.d.ts +10 -0
  418. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_basisu.d.ts +9 -0
  419. package/five/model/loaders/glTF-helpers/extensions/KHR_texture_transform.d.ts +10 -0
  420. package/five/model/loaders/glTF-helpers/extensions/REALSEE_materials_lightmap.d.ts +7 -0
  421. package/five/model/loaders/glTF-helpers/extensions/base.d.ts +24 -0
  422. package/five/model/loaders/glTF-helpers/glTF.d.ts +713 -0
  423. package/five/model/loaders/glTF-helpers/index.d.ts +47 -0
  424. package/five/model/loaders/glTF-helpers/parser.d.ts +114 -0
  425. package/five/model/loaders/glTF-helpers/type.d.ts +14 -0
  426. package/five/model/loaders/gltf.d.ts +10 -0
  427. package/five/model/loaders/obj.d.ts +9 -0
  428. package/five/model/loaders/pbm.d.ts +26 -0
  429. package/five/model/loaders/ply.d.ts +24 -0
  430. package/five/model/loaders/pnts.d.ts +8 -0
  431. package/five/model/loaders/protobuf/dome.d.ts +540 -0
  432. package/five/model/loaders/protobuf/pbm.d.ts +203 -0
  433. package/five/model/loaders/shared.d.ts +16 -0
  434. package/five/model/loaders/splat.d.ts +8 -0
  435. package/five/model/loaders/spz.d.ts +14 -0
  436. package/five/model/loaders/tile3d-helpers/feature-table.d.ts +15 -0
  437. package/five/model/loaders/tile3d-helpers/gl-type.d.ts +20 -0
  438. package/five/model/loaders/tile3d-helpers/parse-gltf-array-buffer.d.ts +2 -0
  439. package/five/model/loaders/tile3d-helpers/parse-header.d.ts +2 -0
  440. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.d.ts +2 -0
  441. package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.worker.d.ts +6 -0
  442. package/five/model/loaders/tile3d-helpers/parse-table.d.ts +3 -0
  443. package/five/model/loaders/tile3d-helpers/tile3d-type.d.ts +35 -0
  444. package/five/model/loaders/x3p.d.ts +22 -0
  445. package/five/model/materials/pbmMaterial.d.ts +87 -0
  446. package/five/model/materials/pbmMeshMaterial.d.ts +124 -0
  447. package/five/model/materials/pbmPointCloudMaterial.d.ts +72 -0
  448. package/five/model/model-scene.d.ts +172 -0
  449. package/five/model/model.d.ts +209 -0
  450. package/five/model/objects/pbmContainer.d.ts +28 -0
  451. package/five/model/objects/pbmGSObject.d.ts +40 -0
  452. package/five/model/objects/pbmGSRenderMesh.d.ts +32 -0
  453. package/five/model/objects/pbmGroup.d.ts +8 -0
  454. package/five/model/objects/pbmMesh.d.ts +10 -0
  455. package/five/model/objects/pbmPointCloud.d.ts +7 -0
  456. package/five/model/parameter.d.ts +136 -0
  457. package/five/model/shaders/pbm_gaussian_splatting/fragment.d.ts +2 -0
  458. package/five/model/shaders/pbm_gaussian_splatting/vertex.d.ts +2 -0
  459. package/five/model/shaders/pbm_mesh_basic/fragment.d.ts +2 -0
  460. package/five/model/shaders/pbm_mesh_basic/vertex.d.ts +2 -0
  461. package/five/model/shaders/pbm_mesh_none/fragment.d.ts +2 -0
  462. package/five/model/shaders/pbm_mesh_none/vertex.d.ts +2 -0
  463. package/five/model/shaders/pbm_mesh_phong/fragment.d.ts +2 -0
  464. package/five/model/shaders/pbm_mesh_phong/vertex.d.ts +2 -0
  465. package/five/model/shaders/pbm_mesh_standard/fragment.d.ts +2 -0
  466. package/five/model/shaders/pbm_mesh_standard/vertex.d.ts +2 -0
  467. package/five/model/shaders/pbm_pointcloud/fragment.d.ts +2 -0
  468. package/five/model/shaders/pbm_pointcloud/vertex.d.ts +2 -0
  469. package/five/model/tile3d/header.d.ts +88 -0
  470. package/five/model/tile3d/index.d.ts +214 -0
  471. package/five/model/tile3d/tile-cache.d.ts +18 -0
  472. package/five/model/tile3d/tile-content.d.ts +10 -0
  473. package/five/model/tile3d/tile-node.d.ts +24 -0
  474. package/five/model/tile3d/tile-request-scheduler.d.ts +17 -0
  475. package/five/model/tile3d/tile.d.ts +79 -0
  476. package/five/model/tile3d/tileset-base-traverser.d.ts +59 -0
  477. package/five/model/tile3d/tileset-most-detail-traverser.d.ts +14 -0
  478. package/five/model/tile3d/tileset-normal-traverser.d.ts +15 -0
  479. package/five/model/tile3d/tileset-skip-traverser.d.ts +60 -0
  480. package/five/model/tile3d/tileset.d.ts +69 -0
  481. package/five/model/tile3d/trajectory-content.d.ts +9 -0
  482. package/five/model/tile3d/trajectory-node.d.ts +15 -0
  483. package/five/model/tile3d/trajectory.d.ts +30 -0
  484. package/five/model/tile3d/types.d.ts +33 -0
  485. package/five/model/view-layer.d.ts +20 -0
  486. package/five/renderer/five-renderer.d.ts +17 -0
  487. package/five/renderer/index.d.ts +3 -0
  488. package/five/renderer/postprocessing/composer.d.ts +37 -0
  489. package/five/renderer/postprocessing/index.d.ts +7 -0
  490. package/five/renderer/postprocessing/passes/adaptive-luminance-pass.d.ts +15 -0
  491. package/five/renderer/postprocessing/passes/eye-dome-lighting-pass.d.ts +14 -0
  492. package/five/renderer/postprocessing/passes/flowing-light-2d-pass.d.ts +36 -0
  493. package/five/renderer/postprocessing/passes/flowing-light-3d-pass.d.ts +36 -0
  494. package/five/renderer/postprocessing/passes/gaussian-blur-pass.d.ts +12 -0
  495. package/five/renderer/postprocessing/passes/pass.d.ts +38 -0
  496. package/five/renderer/scene-renderers/point-cloud-high-quality-scene-renderer.d.ts +11 -0
  497. package/five/renderer/scene-renderers/scene-renderer.d.ts +9 -0
  498. package/five/renderer/scene-renderers/ssaa-scene-renderer.d.ts +15 -0
  499. package/five/renderer/tools/full-screen-quad.d.ts +15 -0
  500. package/five/renderer/tools/render-full-screen-depth.d.ts +2 -0
  501. package/five/renderer/tools/render-full-screen.d.ts +2 -0
  502. package/five/texture/imageBitmap.d.ts +13 -0
  503. package/five/texture/initTexture.d.ts +3 -0
  504. package/five/texture/loader.d.ts +39 -0
  505. package/five/thirdparty/fflate.d.ts +1407 -0
  506. package/five/thirdparty/hammer.d.ts +259 -0
  507. package/five/thirdparty/jsrsasign.d.ts +768 -0
  508. package/five/thirdparty/meshopt_decoder.d.ts +15 -0
  509. package/five/three-version-check.d.ts +1 -0
  510. package/five/types/addableObject.d.ts +12 -0
  511. package/five/types/cube.d.ts +1 -0
  512. package/five/types/gestureInput.d.ts +24 -0
  513. package/five/types/imageOptions.d.ts +20 -0
  514. package/five/types/intersectMeshInterface.d.ts +8 -0
  515. package/five/types/movePanoEffect.d.ts +13 -0
  516. package/five/types/movePanoOptions.d.ts +35 -0
  517. package/five/types/panoCircleMeshInterface.d.ts +34 -0
  518. package/five/types/plugin.d.ts +25 -0
  519. package/five/types/pose.d.ts +17 -0
  520. package/five/types/state.d.ts +20 -0
  521. package/five/types/viewport.d.ts +22 -0
  522. package/five/utils/ajax.d.ts +66 -0
  523. package/five/utils/animationFrameLoop.d.ts +45 -0
  524. package/five/utils/array.d.ts +31 -0
  525. package/five/utils/asyncTaskQueue.d.ts +8 -0
  526. package/five/utils/bufferGeometry.d.ts +33 -0
  527. package/five/utils/calculateProgress.d.ts +39 -0
  528. package/five/utils/calculateThreeMouse.d.ts +13 -0
  529. package/five/utils/canplayVideo.d.ts +2 -0
  530. package/five/utils/clamp.d.ts +2 -0
  531. package/five/utils/clock.d.ts +17 -0
  532. package/five/utils/createSymbol.d.ts +5 -0
  533. package/five/utils/decodeText.d.ts +2 -0
  534. package/five/utils/deepEqual.d.ts +2 -0
  535. package/five/utils/deepFreeze.d.ts +2 -0
  536. package/five/utils/defineProperty.d.ts +9 -0
  537. package/five/utils/detector.d.ts +14 -0
  538. package/five/utils/distance.d.ts +10 -0
  539. package/five/utils/draco.d.ts +26 -0
  540. package/five/utils/easing.d.ts +63 -0
  541. package/five/utils/event.d.ts +149 -0
  542. package/five/utils/formatRad.d.ts +7 -0
  543. package/five/utils/imageSupport.d.ts +6 -0
  544. package/five/utils/imageURL.d.ts +42 -0
  545. package/five/utils/isEmptyObject.d.ts +2 -0
  546. package/five/utils/isNil.d.ts +6 -0
  547. package/five/utils/isNumber.d.ts +2 -0
  548. package/five/utils/isPowerOfTwo.d.ts +2 -0
  549. package/five/utils/isPromise.d.ts +2 -0
  550. package/five/utils/isSimilar.d.ts +6 -0
  551. package/five/utils/json.d.ts +7 -0
  552. package/five/utils/ktx2.d.ts +30 -0
  553. package/five/utils/lzma/index.d.ts +2 -0
  554. package/five/utils/lzma/lzma.d.ts +3 -0
  555. package/five/utils/lzma/lzmaWASM.d.ts +2 -0
  556. package/five/utils/lzma/lzmaWorker.d.ts +14 -0
  557. package/five/utils/memoryUsage.d.ts +29 -0
  558. package/five/utils/motion.d.ts +38 -0
  559. package/five/utils/noop.d.ts +6 -0
  560. package/five/utils/now.d.ts +7 -0
  561. package/five/utils/pano.d.ts +9 -0
  562. package/five/utils/pick.d.ts +3 -0
  563. package/five/utils/poseUtils.d.ts +5 -0
  564. package/five/utils/renderCubeTextureToCubeRenderTarget.d.ts +3 -0
  565. package/five/utils/renderDepth.d.ts +2 -0
  566. package/five/utils/renderTexturesToCubeRenderTarget.d.ts +10 -0
  567. package/five/utils/requestPermission.d.ts +3 -0
  568. package/five/utils/shaderContentFix.d.ts +7 -0
  569. package/five/utils/shaderMaterial.d.ts +20 -0
  570. package/five/utils/stateUtils.d.ts +5 -0
  571. package/five/utils/string-pattern.d.ts +8 -0
  572. package/five/utils/subscribe.d.ts +67 -0
  573. package/five/utils/tileCube.d.ts +19 -0
  574. package/five/utils/toFastProperties.d.ts +1 -0
  575. package/five/utils/typedCache.d.ts +10 -0
  576. package/five/utils/uniform.d.ts +15 -0
  577. package/five/utils/url.d.ts +35 -0
  578. package/five/utils/uuid.d.ts +5 -0
  579. package/five/utils/values.d.ts +2 -0
  580. package/five/utils/vectorCoordinates.d.ts +29 -0
  581. package/five/utils/volume.d.ts +111 -0
  582. package/five/utils/webglError.d.ts +7 -0
  583. package/five/utils/worker.d.ts +26 -0
  584. package/five/webxr/XRControllerModelFactory.d.ts +28 -0
  585. package/five/webxr/motionHelper.d.ts +68 -0
  586. package/five/webxr/xrButton.d.ts +4 -0
  587. package/five/webxr/xrController.d.ts +24 -0
  588. package/five/webxr/xrManager.d.ts +84 -0
  589. package/five/work/_ALLOW_HOST.d.ts +2 -0
  590. package/five/work/index.d.ts +6 -0
  591. package/five/work/keychain.d.ts +5 -0
  592. package/five/work/looseWorkType.d.ts +121 -0
  593. package/five/work/verify.d.ts +7 -0
  594. package/five/work/work.d.ts +236 -0
  595. package/five/work/workFetcher.d.ts +4 -0
  596. package/five/work/workJson.d.ts +3 -0
  597. package/five/work/workJsonType.d.ts +73 -0
  598. package/five/work/workObserverUtils.d.ts +36 -0
  599. package/five/work/workParser.d.ts +6 -0
  600. package/five/work/workResolvedObserver.d.ts +12 -0
  601. package/five/work/workVerify.d.ts +2 -0
  602. package/five/work/works.d.ts +10 -0
  603. package/gltf-loader/gltf-object.d.ts +17 -0
  604. package/gltf-loader/index.d.ts +60 -160
  605. package/gltf-loader/index.js +3 -3
  606. package/gltf-loader/index.mjs +3 -3
  607. package/gltf-loader/thirdparty/DDSLoader.d.ts +23 -0
  608. package/gltf-loader/thirdparty/DRACOLoader.d.ts +18 -0
  609. package/gltf-loader/thirdparty/GLTFLoader.d.ts +59 -0
  610. package/line/circle_png.d.ts +1 -0
  611. package/line/index.d.ts +19 -69
  612. package/line/index.js +3 -3
  613. package/line/index.mjs +3 -3
  614. package/line/utils/Line2.d.ts +7 -0
  615. package/line/utils/LineGeometry.d.ts +10 -0
  616. package/line/utils/LineMaterial.d.ts +20 -0
  617. package/line/utils/LineSegments2.d.ts +11 -0
  618. package/line/utils/LineSegmentsGeometry.d.ts +15 -0
  619. package/llms.txt +65 -0
  620. package/package.json +10 -1
  621. package/plugins/BackgroundPlugin/Controller.d.ts +20 -0
  622. package/plugins/BackgroundPlugin/index.d.ts +5 -0
  623. package/plugins/BackgroundPlugin/typings.d.ts +44 -0
  624. package/plugins/BasePlugin/index.d.ts +119 -0
  625. package/plugins/DynamicPathLinePlugin/Controller.d.ts +167 -0
  626. package/plugins/DynamicPathLinePlugin/index.d.ts +5 -0
  627. package/plugins/DynamicPathLinePlugin/line2/Line2.d.ts +7 -0
  628. package/plugins/DynamicPathLinePlugin/line2/LineGeometry.d.ts +10 -0
  629. package/plugins/DynamicPathLinePlugin/line2/LineMaterial.d.ts +17 -0
  630. package/plugins/DynamicPathLinePlugin/line2/LineSegments2.d.ts +11 -0
  631. package/plugins/DynamicPathLinePlugin/line2/LineSegmentsGeometry.d.ts +15 -0
  632. package/plugins/DynamicPathLinePlugin/typing.d.ts +129 -0
  633. package/plugins/DynamicPathLinePlugin/typings.d.ts +72 -0
  634. package/plugins/ItemMaskPlugin/Controller.d.ts +48 -0
  635. package/plugins/ItemMaskPlugin/index.d.ts +5 -0
  636. package/plugins/ItemMaskPlugin/typing.d.ts +58 -0
  637. package/plugins/OrientationPlugin/Controller.d.ts +82 -0
  638. package/plugins/OrientationPlugin/RoundedBoxGeometry.d.ts +11 -0
  639. package/plugins/OrientationPlugin/index.d.ts +6 -0
  640. package/plugins/OrientationPlugin/typing.d.ts +25 -0
  641. package/plugins/PanoAnimePlugin/Controller.d.ts +46 -0
  642. package/plugins/PanoAnimePlugin/index.d.ts +5 -0
  643. package/plugins/PanoAnimePlugin/typing.d.ts +37 -0
  644. package/plugins/PluginTemplate/Controller.d.ts +27 -0
  645. package/plugins/PluginTemplate/index.d.ts +5 -0
  646. package/plugins/PluginTemplate/typing.d.ts +21 -0
  647. package/plugins/TrajectoryPlugin/Controller.d.ts +85 -0
  648. package/plugins/TrajectoryPlugin/index.d.ts +6 -0
  649. package/plugins/TrajectoryPlugin/typing.d.ts +25 -0
  650. package/plugins/index.d.ts +9 -1078
  651. package/plugins/index.js +17 -17
  652. package/plugins/index.mjs +1518 -1370
  653. package/plugins/thirdParty/CSS3DRenderer.d.ts +32 -0
  654. package/plugins/thirdParty/OrbitControls.d.ts +78 -0
  655. package/plugins/utils/absoluteUrl.d.ts +5 -0
  656. package/plugins/utils/clamp.d.ts +2 -0
  657. package/plugins/utils/loadImage.d.ts +1 -0
  658. package/plugins/utils/motion.d.ts +38 -0
  659. package/plugins/utils/now.d.ts +6 -0
  660. package/plugins/utils/uuid.d.ts +5 -0
  661. package/react/canvas.d.ts +19 -0
  662. package/react/context.d.ts +11 -0
  663. package/react/createProvider.d.ts +95 -0
  664. package/react/createStore.d.ts +144 -0
  665. package/react/hooks/unsafe__useFiveInstance.d.ts +9 -0
  666. package/react/hooks/useFiveAction.d.ts +147 -0
  667. package/react/hooks/useFiveCameraDirection.d.ts +7 -0
  668. package/react/hooks/useFiveCameraRaycaster.d.ts +7 -0
  669. package/react/hooks/useFiveCurrentObserver.d.ts +11 -0
  670. package/react/hooks/useFiveCurrentState.d.ts +15 -0
  671. package/react/hooks/useFiveEventCallback.d.ts +12 -0
  672. package/react/hooks/useFiveFloor.d.ts +15 -0
  673. package/react/hooks/useFiveHelper.d.ts +14 -0
  674. package/react/hooks/useFiveModelBounding.d.ts +5 -0
  675. package/react/hooks/useFiveModelEffect.d.ts +14 -0
  676. package/react/hooks/useFiveModelIntersectRaycaster.d.ts +22 -0
  677. package/react/hooks/useFiveModelReadyState.d.ts +8 -0
  678. package/react/hooks/useFiveProject2d.d.ts +20 -0
  679. package/react/hooks/useFiveSceneEffect.d.ts +21 -0
  680. package/react/hooks/useFiveState.d.ts +6 -0
  681. package/react/hooks/useFiveWork.d.ts +29 -0
  682. package/react/index.d.ts +24 -830
  683. package/react/index.js +2 -2
  684. package/react/index.mjs +2 -2
  685. package/react/rendererPool.d.ts +7 -0
  686. package/react/withFive.d.ts +213 -0
  687. package/shader-lib/EvenessPlane/index.d.ts +10 -0
  688. package/shader-lib/PointCloudExpand/index.d.ts +59 -0
  689. package/shader-lib/PolygonCuter/index.d.ts +52 -0
  690. package/shader-lib/PolygonCuter/worker.d.ts +14 -0
  691. package/shader-lib/ShineModel/index.d.ts +7 -0
  692. package/shader-lib/SweepModel/index.d.ts +7 -0
  693. package/shader-lib/index.d.ts +5 -86
  694. package/shader-lib/index.js +2 -2
  695. package/shader-lib/index.mjs +2 -2
  696. package/sticker/geometry.d.ts +3 -0
  697. package/sticker/index.d.ts +68 -71
  698. package/sticker/index.js +3 -3
  699. package/sticker/index.mjs +3 -3
  700. package/umd/five-gltf-loader.js +3 -3
  701. package/umd/five-line.js +3 -3
  702. package/umd/five-plugins.js +16 -16
  703. package/umd/five-react.js +2 -2
  704. package/umd/five-shader-lib.js +2 -2
  705. package/umd/five-sticker.js +3 -3
  706. package/umd/five-vfx.js +2 -2
  707. package/umd/five-vue.js +2 -2
  708. package/umd/five.js +605 -92
  709. package/vfx/airflow/airflow.d.ts +18 -0
  710. package/vfx/airflow/fragment-shader.d.ts +2 -0
  711. package/vfx/airflow/vertex-shader.d.ts +2 -0
  712. package/vfx/common/scale-shader.d.ts +2 -0
  713. package/vfx/common/simplex-noise-shader.d.ts +2 -0
  714. package/vfx/frame/fragment-shader.d.ts +2 -0
  715. package/vfx/frame/frame.d.ts +22 -0
  716. package/vfx/frame/vertex-shader.d.ts +2 -0
  717. package/vfx/index.d.ts +7 -363
  718. package/vfx/index.js +2 -2
  719. package/vfx/index.mjs +2 -2
  720. package/vfx/particle/fragment-shader.d.ts +2 -0
  721. package/vfx/particle/instance.d.ts +36 -0
  722. package/vfx/particle/particle.d.ts +205 -0
  723. package/vfx/particle/utils.d.ts +11 -0
  724. package/vfx/particle/vertex-shader.d.ts +2 -0
  725. package/vfx/particle-gpu/fragment-shader.d.ts +2 -0
  726. package/vfx/particle-gpu/instance.d.ts +36 -0
  727. package/vfx/particle-gpu/particle.d.ts +95 -0
  728. package/vfx/particle-gpu/utils.d.ts +11 -0
  729. package/vfx/particle-gpu/vertex-shader.d.ts +2 -0
  730. package/vfx/spotLight/fragment-shader.d.ts +2 -0
  731. package/vfx/spotLight/spotLight.d.ts +15 -0
  732. package/vfx/spotLight/vertex-shader.d.ts +2 -0
  733. package/vue/context.d.ts +7 -0
  734. package/vue/hooks/FiveCanvas.d.ts +36 -0
  735. package/vue/hooks/FiveProvider.d.ts +35 -0
  736. package/vue/hooks/unsafe__useFiveInject.d.ts +9 -0
  737. package/vue/hooks/useFiveAction.d.ts +178 -0
  738. package/vue/hooks/useFiveCameraDirection.d.ts +8 -0
  739. package/vue/hooks/useFiveCameraRaycaster.d.ts +8 -0
  740. package/vue/hooks/useFiveCurrentObserver.d.ts +12 -0
  741. package/vue/hooks/useFiveCurrentState.d.ts +16 -0
  742. package/vue/hooks/useFiveEventCallback.d.ts +11 -0
  743. package/vue/hooks/useFiveFloor.d.ts +16 -0
  744. package/vue/hooks/useFiveHelper.d.ts +15 -0
  745. package/vue/hooks/useFiveModel.d.ts +7 -0
  746. package/vue/hooks/useFiveModelBounding.d.ts +7 -0
  747. package/vue/hooks/useFiveModelIntersectRaycaster.d.ts +23 -0
  748. package/vue/hooks/useFiveModelReadyState.d.ts +9 -0
  749. package/vue/hooks/useFiveProject2d.d.ts +26 -0
  750. package/vue/hooks/useFiveScene.d.ts +6 -0
  751. package/vue/hooks/useFiveState.d.ts +16 -0
  752. package/vue/hooks/useFiveWork.d.ts +30 -0
  753. package/vue/index.d.ts +23 -467
  754. package/vue/index.js +2 -2
  755. package/vue/index.mjs +2 -2
  756. package/vue/rendererPool.d.ts +10 -0
  757. package/work-downloader/components/model-3d-tile.d.ts +2 -0
  758. package/work-downloader/components/model.d.ts +3 -0
  759. package/work-downloader/components/observer.d.ts +7 -0
  760. package/work-downloader/download.d.ts +16 -0
  761. package/work-downloader/index.d.ts +2 -33
  762. package/work-downloader/index.js +2 -2
  763. package/work-downloader/index.mjs +2 -2
  764. package/work-downloader/type.d.ts +28 -0
  765. package/work-downloader/utils/download-to-file.d.ts +1 -0
  766. package/work-downloader/utils/image-processing.d.ts +7 -0
  767. package/work-downloader/utils/join-url.d.ts +2 -0
  768. package/work-downloader/utils/log.d.ts +1 -0
  769. package/work-downloader/utils/relative-url.d.ts +1 -0
  770. package/docs/documents/coordinate.html +0 -9
  771. package/docs/documents/five.FivePlugin.plugins.html +0 -77
  772. package/docs/documents/five.Pose.coordinate.html +0 -9
  773. package/docs/documents/plugins.html +0 -77
  774. package/docs/documents/react-component.html +0 -32
  775. package/docs/media/coordinate.jpg +0 -0
@@ -0,0 +1,768 @@
1
+ /**
2
+ * @license
3
+ * The 'jsrsasign'(RSA-Sign JavaScript Library) License
4
+ *
5
+ * Copyright (c) 2010-2021 Kenji Urushima
6
+ *
7
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ * of this software and associated documentation files (the "Software"), to deal
9
+ * in the Software without restriction, including without limitation the rights
10
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ * copies of the Software, and to permit persons to whom the Software is
12
+ * furnished to do so, subject to the following conditions:
13
+ *
14
+ * The above copyright notice and this permission notice shall be included in
15
+ * all copies or substantial portions of the Software.
16
+ *
17
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23
+ * THE SOFTWARE.
24
+ *
25
+ * LICENSE: MIT License
26
+ */
27
+ /**
28
+ * @license
29
+ * RSA and ECC in JavaScript
30
+ *
31
+ * Copyright (c) 2003-2005 Tom Wu All Rights Reserved.
32
+ *
33
+ * Permission is hereby granted, free of charge, to any person obtaining
34
+ * a copy of this software and associated documentation files (the
35
+ * "Software"), to deal in the Software without restriction, including
36
+ * without limitation the rights to use, copy, modify, merge, publish,
37
+ * distribute, sublicense, and/or sell copies of the Software, and to
38
+ * permit persons to whom the Software is furnished to do so, subject to
39
+ * the following conditions:
40
+ *
41
+ * The above copyright notice and this permission notice shall be
42
+ * included in all copies or substantial portions of the Software.
43
+ *
44
+ * THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
45
+ * EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
46
+ * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
47
+ *
48
+ * IN NO EVENT SHALL TOM WU BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
49
+ * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES WHATSOEVER
50
+ * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR NOT ADVISED OF
51
+ * THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF LIABILITY, ARISING OUT
52
+ * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
53
+ *
54
+ * In addition, the following condition applies:
55
+ *
56
+ * All redistributions must retain an intact copy of this copyright notice
57
+ * and disclaimer.
58
+ *
59
+ * http://www-cs-students.stanford.edu/~tjw/jsbn/
60
+ * LICENSE: BSD License
61
+ * PART: ext/{base64,jsbn,jsbn2,prgn4,rng,rsa,rsa2}
62
+ */
63
+ /**
64
+ * @license
65
+ * CryptoJS
66
+ *
67
+ * Copyright (c) 2009-2013 Jeff Mott
68
+ *
69
+ * Permission is hereby granted, free of charge, to any person obtaining
70
+ * a copy of this software and associated documentation files (the
71
+ * "Software"), to deal in the Software without restriction, including
72
+ * without limitation the rights to use, copy, modify, merge, publish,
73
+ * distribute, sublicense, and/or sell copies of the Software, and to
74
+ * permit persons to whom the Software is furnished to do so, subject to
75
+ * the following conditions:
76
+ *
77
+ * The above copyright notice and this permission notice shall be
78
+ * included in all copies or substantial portions of the Software.
79
+ *
80
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
81
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
82
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
83
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
84
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
85
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
86
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
87
+ *
88
+ * https://code.google.com/p/crypto-js/wiki/License
89
+ * PART: ext/cryptojs
90
+ */
91
+ declare var KJUR: {};
92
+ declare function hex2b64(d: any): string;
93
+ declare function b64tohex(f: any): string;
94
+ declare function RSAKey(): void;
95
+ declare namespace RSAKey {
96
+ var getPosArrayOfChildrenFromHex: (a: any) => any;
97
+ var getHexValueArrayOfChildrenFromHex: (f: any) => any;
98
+ var SALT_LEN_HLEN: number;
99
+ var SALT_LEN_MAX: number;
100
+ var SALT_LEN_RECOVER: number;
101
+ }
102
+ declare function hextopem(a: any, b: any): string;
103
+ declare function pemtohex(a: any, b: any): string;
104
+ declare function X509(q: any): void;
105
+ declare namespace X509 {
106
+ var hex2dn: (e: any, b: any) => any;
107
+ var hex2rdn: (f: any, b: any) => string;
108
+ var hex2attrTypeValue: (d: any, i: any) => string;
109
+ var getPublicKeyFromCertHex: (b: any) => any;
110
+ var getPublicKeyFromCertPEM: (b: any) => any;
111
+ var getPublicKeyInfoPropOfCertPEM: (c: any) => {};
112
+ var KEYUSAGE_NAME: string[];
113
+ }
114
+ declare namespace KJUR {
115
+ namespace crypto { }
116
+ }
117
+ interface ECCPrivateKey {
118
+ curve: string;
119
+ d: string;
120
+ }
121
+ interface pemtohex {
122
+ (pem: string): string;
123
+ }
124
+ interface hextopem {
125
+ (pem: string, shead: string): string;
126
+ }
127
+ interface b64tohex {
128
+ (pem: string): string;
129
+ }
130
+ interface hex2b64 {
131
+ (pem: string): string;
132
+ }
133
+ /** Tom Wu's RSA Key class and extension */
134
+ declare class RSAKey {
135
+ constructor();
136
+ /**
137
+ * static method to get array of hex field values from hexadecimal PKCS#5 RSA private key.
138
+ * @param sPEMPrivateKey PEM PKCS#1/5 s private key string
139
+ * @return array of field hex value
140
+ * @example
141
+ * RSAKey.getHexValueArrayOfChildrenFromHex("3082...") → ["00", "3b42...", ...]
142
+ */
143
+ static getHexValueArrayOfChildrenFromHex(sPEMPrivateKey: string): string[];
144
+ /**
145
+ * static method to get array of field positions from hexadecimal PKCS#5 RSA private key.
146
+ * @param sPEMPrivateKey PEM PKCS#1/5 s private key string
147
+ * @return array of field positions
148
+ * @example
149
+ * RSAKey.getPosArrayOfChildrenFromHex("3082...") → [8, 32, ...]
150
+ */
151
+ static getPosArrayOfChildrenFromHex(sPEMPrivateKey: string): number[];
152
+ /**
153
+ * read an ASN.1 hexadecimal string of X.509 RSA public key certificate
154
+ * @param h hexadecimal string of X.509 RSA public key certificate
155
+ * @param nthPKI nth index of publicKeyInfo. (DEFAULT: 6 for X509v3)
156
+ */
157
+ readCertPubKeyHex(h: string, nthPKI: number): void;
158
+ /**
159
+ * read an ASN.1 hexadecimal string of PKCS#1/5 plain RSA private key
160
+ * @param h hexadecimal string of PKCS#1/5 plain RSA private key
161
+ */
162
+ readPKCS5PrvKeyHex(h: string): void;
163
+ /**
164
+ * read an ASN.1 hexadecimal string of PKCS#5 RSA public key
165
+ * @param h hexadecimal string of PKCS#5 public key
166
+ */
167
+ readPKCS5PubKeyHex(h: string): void;
168
+ /**
169
+ * read an ASN.1 hexadecimal string of PKCS#8 plain RSA private key
170
+ * @param h hexadecimal string of PKCS#8 plain RSA private key
171
+ */
172
+ readPKCS8PrvKeyHex(h: string): void;
173
+ /**
174
+ * read an ASN.1 hexadecimal string of PKCS#8 RSA public key
175
+ * @param h hexadecimal string of PKCS#8 public key
176
+ */
177
+ readPKCS8PubKeyHex(h: string): void;
178
+ /**
179
+ * read PKCS#1 private key from a string
180
+ * @param keyPEM string of PKCS#1 private key.
181
+ */
182
+ readPrivateKeyFromPEMString(keyPEM: string): void;
183
+ /**
184
+ * verifies a sigature for a message string with RSA public key.
185
+ * @param sMsg message string to be verified.
186
+ * @param hSig hexadecimal string of signature.
187
+ * non-hexadecimal characters including new lines will be ignored.
188
+ * @return returns 1 if valid, otherwise 0
189
+ */
190
+ verify(sMsg: string, hSig: string): 0 | 1;
191
+ /**
192
+ * verifies a sigature for a message string with RSA public key by PKCS#1 PSS sign.
193
+ * @param sMsg message string to be verified.
194
+ * @param hSig hexadecimal string of signature value
195
+ * @param hashAlg hash algorithm name
196
+ * @param sLen salt byte length from 0 to (keybytelen - hashbytelen - 2).
197
+ * There are two special values:
198
+ * * -1: sets the salt length to the digest length
199
+ * * -2: sets the salt length to maximum permissible value
200
+ * (i.e. keybytelen - hashbytelen - 2)
201
+ *
202
+ * DEFAULT is -1. (NOTE: OpenSSL's default is -2.)
203
+ * @return returns true if valid, otherwise false
204
+ */
205
+ static verifyPSS(sMsg: string, hSig: string, hashAlg: string, sLen: number): boolean;
206
+ /**
207
+ * verifies a sigature for a message string with RSA public key.
208
+ * @param sHashHex hexadecimal hash value of message to be verified.
209
+ * @param hSig hexadecimal string of signature.
210
+ * non-hexadecimal charactors including new lines will be ignored.
211
+ * @return returns 1 if valid, otherwise 0
212
+ */
213
+ static verifyWithMessageHash(sHashHex: string, hSig: string): 0 | 1;
214
+ /**
215
+ * verifies a sigature for a hash value of message string with RSA public key by PKCS#1 PSS sign.
216
+ * @param hHash hexadecimal hash value of message string to be verified.
217
+ * @param hSig hexadecimal string of signature value
218
+ * @param hashAlg hash algorithm name
219
+ * @param sLen salt byte length from 0 to (keybytelen - hashbytelen - 2).
220
+ * There are two special values:
221
+ * * -1: sets the salt length to the digest length
222
+ * * -2: sets the salt length to maximum permissible value
223
+ * (i.e. keybytelen - hashbytelen - 2)
224
+ *
225
+ * DEFAULT is -1 (NOTE: OpenSSL's default is -2.)
226
+ * @return returns true if valid, otherwise false
227
+ */
228
+ static verifyWithMessageHashPSS(hHash: string, hSig: string, hashAlg: string, sLen: number): boolean;
229
+ }
230
+ interface X509Extension {
231
+ oid: string;
232
+ critical: boolean;
233
+ vidx: number;
234
+ }
235
+ interface PublicKeyInfoPropOfCertPEMResult {
236
+ /** hexadecimal string of OID of asymmetric key algorithm */
237
+ algoid: string;
238
+ /** hexadecimal string of OID of ECC curve name or null */
239
+ algparam: string | null;
240
+ /** hexadecimal string of key in the certificate */
241
+ keyhex: string;
242
+ }
243
+ declare class X509 {
244
+ hex: string;
245
+ static readonly version: string;
246
+ constructor();
247
+ /**
248
+ * get format version (X.509v1 or v3 certificate)
249
+ * @return 1 for X509v1, 3 for X509v3, otherwise 0
250
+ * @description
251
+ * This method returns a format version of X.509 certificate.
252
+ * It returns 1 for X.509v1 certificate and 3 for v3 certificate.
253
+ * Otherwise returns 0.
254
+ * This method will be automatically called in
255
+ * `X509#readCertPEM`. After then, you can use
256
+ * `X509.version` parameter.
257
+ * @example
258
+ * var x = new X509();
259
+ * x.readCertPEM(sCertPEM);
260
+ * version = x.getVersion(); // 1 or 3
261
+ * sn = x.getSerialNumberHex(); // return string like "01ad..."
262
+ */
263
+ getVersion(): number;
264
+ /**
265
+ * get hexadecimal string of serialNumber field of certificate.
266
+ * @return hexadecimal string of certificate serial number
267
+ * @example
268
+ * var x = new X509();
269
+ * x.readCertPEM(sCertPEM);
270
+ * var sn = x.getSerialNumberHex(); // return string like "01ad..."
271
+ */
272
+ getSerialNumberHex(): string;
273
+ /**
274
+ * get signature algorithm name in basic field
275
+ * @return signature algorithm name (ex. SHA1withRSA, SHA256withECDSA)
276
+ * @description
277
+ * This method will get a name of signature algorithm field of certificate:
278
+ * @example
279
+ * var x = new X509();
280
+ * x.readCertPEM(sCertPEM);
281
+ * algName = x.getSignatureAlgorithmField();
282
+ */
283
+ getSignatureAlgorithmField(): string;
284
+ /**
285
+ * get hexadecimal string of issuer field TLV of certificate.
286
+ * @return hexadecial string of issuer DN ASN.1
287
+ * @example
288
+ * var x = new X509();
289
+ * x.readCertPEM(sCertPEM);
290
+ * var issuer = x.getIssuerHex(); // return string like "3013..."
291
+ */
292
+ getIssuerHex(): string;
293
+ /**
294
+ * get string of issuer field of certificate.
295
+ * @return issuer DN string
296
+ * @example
297
+ * var x = new X509();
298
+ * x.readCertPEM(sCertPEM);
299
+ * var issuer = x.getIssuerString(); // return string like "/C=US/O=TEST"
300
+ */
301
+ getIssuerString(): string;
302
+ /**
303
+ * get hexadecimal string of subject field of certificate.
304
+ * @return hexadecial string of subject DN ASN.1
305
+ * @example
306
+ * var x = new X509();
307
+ * x.readCertPEM(sCertPEM);
308
+ * var subject = x.getSubjectHex(); // return string like "3013..."
309
+ */
310
+ getSubjectHex(): string;
311
+ /**
312
+ * get string of subject field of certificate.
313
+ * @return subject DN string
314
+ * @example
315
+ * var x = new X509();
316
+ * x.readCertPEM(sCertPEM);
317
+ * var subject = x.getSubjectString(); // return string like "/C=US/O=TEST"
318
+ */
319
+ getSubjectString(): string;
320
+ /**
321
+ * get notBefore field string of certificate.
322
+ * @return not before time value (ex. "151231235959Z")
323
+ * @example
324
+ * var x = new X509();
325
+ * x.readCertPEM(sCertPEM);
326
+ * var notBefore = x.getNotBefore(); // return string like "151231235959Z"
327
+ */
328
+ getNotBefore(): string;
329
+ /**
330
+ * get notAfter field string of certificate.
331
+ * @return not after time value (ex. "151231235959Z")
332
+ * @example
333
+ * var x = new X509();
334
+ * x.readCertPEM(sCertPEM);
335
+ * var notAfter = x.getNotAfter(); // return string like "151231235959Z"
336
+ */
337
+ getNotAfter(): string;
338
+ /**
339
+ * get a hexadecimal string of subjectPublicKeyInfo field.
340
+ * @return ASN.1 SEQUENCE hexadecimal string of subjectPublicKeyInfo field
341
+ * @example
342
+ * x = new X509();
343
+ * x.readCertPEM(sCertPEM);
344
+ * hSPKI = x.getPublicKeyHex(); // return string like "30820122..."
345
+ */
346
+ getPublicKeyHex(): string;
347
+ /**
348
+ * get a string index of subjectPublicKeyInfo field for hexadecimal string certificate.
349
+ * @return string index of subjectPublicKeyInfo field for hexadecimal string certificate.
350
+ * @example
351
+ * x = new X509();
352
+ * x.readCertPEM(sCertPEM);
353
+ * idx = x.getPublicKeyIdx(); // return string index in x.hex parameter
354
+ */
355
+ getPublicKeyIdx(): number;
356
+ /**
357
+ * get a string index of contents of subjectPublicKeyInfo BITSTRING value from hexadecimal certificate
358
+ * @return string index of key contents
359
+ * @example
360
+ * x = new X509();
361
+ * x.readCertPEM(sCertPEM);
362
+ * idx = x.getPublicKeyContentIdx(); // return string index in x.hex parameter
363
+ */
364
+ getPublicKeyContentIdx(): number;
365
+ /**
366
+ * get a RSAKey/ECDSA/DSA public key object of subjectPublicKeyInfo field.
367
+ * @return RSAKey/ECDSA/DSA public key object of subjectPublicKeyInfo field
368
+ * @example
369
+ * x = new X509();
370
+ * x.readCertPEM(sCertPEM);
371
+ * pubkey = x.getPublicKey();
372
+ */
373
+ getPublicKey(): RSAKey | KJUR.crypto.DSA | KJUR.crypto.ECDSA;
374
+ /**
375
+ * get signature algorithm name from hexadecimal certificate data
376
+ * @param hCert hexadecimal string of X.509 certificate binary
377
+ * @return signature algorithm name (ex. SHA1withRSA, SHA256withECDSA)
378
+ * @description
379
+ * This method will get signature algorithm name of certificate:
380
+ * @example
381
+ * var x = new X509();
382
+ * x.readCertPEM(sCertPEM);
383
+ * x.getSignatureAlgorithmName() → "SHA256withRSA"
384
+ */
385
+ getSignatureAlgorithmName(): string;
386
+ /**
387
+ * get signature value in hexadecimal string
388
+ * @return signature value hexadecimal string without BitString unused bits
389
+ * @description
390
+ * This method will get signature value of certificate:
391
+ * @example
392
+ * var x = new X509();
393
+ * x.readCertPEM(sCertPEM);
394
+ * x.getSignatureValueHex() → "8a4c47913..."
395
+ */
396
+ getSignatureValueHex(): string;
397
+ /**
398
+ * verifies signature value by public key
399
+ * @param pubKey public key object or hexadecimal string of X.509 certificate
400
+ * @return true if signature value is valid otherwise false
401
+ * @description
402
+ * This method verifies signature value of hexadecimal string of
403
+ * X.509 certificate by specified public key object.
404
+ * @example
405
+ * pubKey = KEYUTIL.getKey(pemPublicKey); // or certificate
406
+ * x = new X509();
407
+ * x.readCertPEM(pemCert);
408
+ * x.verifySignature(pubKey) → true, false or raising exception
409
+ */
410
+ verifySignature(pubKey: string | RSAKey | KJUR.crypto.DSA | KJUR.crypto.ECDSA | ECCPrivateKey): boolean;
411
+ /**
412
+ * set array of X.509v3 extesion information such as extension OID, criticality and value index.
413
+ * @description
414
+ * This method will set an array of X.509v3 extension information having
415
+ * following parameters:
416
+ *
417
+ * - oid - extension OID (ex. 2.5.29.19)
418
+ * - critical - true or false
419
+ * - vidx - string index for extension value
420
+ *
421
+ * @example
422
+ * x = new X509();
423
+ * x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
424
+ *
425
+ * x.aExtInfo →
426
+ * [ { oid: "2.5.29,19", critical: true, vidx: 2504 }, ... ]
427
+ */
428
+ parseExt(params: {
429
+ oid: string;
430
+ critical: boolean;
431
+ vidx: number;
432
+ }): void;
433
+ /**
434
+ * get a X.509v3 extesion information such as extension OID, criticality and value index for specified oid or name.
435
+ * @param oidOrName X.509 extension oid or name (ex. keyUsage or 2.5.29.19)
436
+ * @return X.509 extension information such as extension OID or value indx (see `X509#parseExt`)
437
+ * @description
438
+ * This method will get an X.509v3 extension information JSON object
439
+ * having extension OID, criticality and value idx for specified
440
+ * extension OID or name.
441
+ * If there is no such extension, this returns undefined.
442
+ * @example
443
+ * x = new X509();
444
+ * x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
445
+ *
446
+ * x.getExtInfo("keyUsage") → { oid: "2.5.29.15", critical: true, vidx: 1714 }
447
+ * x.getExtInfo("unknownExt") → undefined
448
+ */
449
+ getExtInfo(oidOrName: string): X509Extension;
450
+ /**
451
+ * get BasicConstraints extension value as object in the certificate
452
+ * @return associative array which may have "cA" and "pathLen" parameters
453
+ * @description
454
+ * This method will get basic constraints extension value as object with following paramters.
455
+ *
456
+ * - cA - CA flag whether CA or not
457
+ * - pathLen - maximum intermediate certificate length
458
+ *
459
+ * There are use cases for return values:
460
+ *
461
+ * - {cA:true, pathLen:3} - cA flag is true and pathLen is 3
462
+ * - {cA:true} - cA flag is true and no pathLen
463
+ * - {} - basic constraints has no value in case of end entity certificate
464
+ * - undefined - there is no basic constraints extension
465
+ *
466
+ * @example
467
+ * x = new X509();
468
+ * x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
469
+ * x.getExtBasicConstraints() → { cA: true, pathLen: 3 };
470
+ */
471
+ getExtBasicConstraints(): {
472
+ cA: boolean;
473
+ pathLen: number;
474
+ };
475
+ /**
476
+ * get KeyUsage extension value as binary string in the certificate
477
+ * @return binary string of key usage bits (ex. '101')
478
+ * @description
479
+ * This method will get key usage extension value
480
+ * as binary string such like '101'.
481
+ * Key usage bits definition is in the RFC 5280.
482
+ * If there is no key usage extension in the certificate,
483
+ * it returns empty string (i.e. '').
484
+ * @example
485
+ * x = new X509();
486
+ * x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
487
+ * x.getExtKeyUsageBin() → '101'
488
+ * // 1 - digitalSignature
489
+ * // 0 - nonRepudiation
490
+ * // 1 - keyEncipherment
491
+ */
492
+ getExtKeyUsageBin(): string;
493
+ /**
494
+ * get KeyUsage extension value as names in the certificate
495
+ * @return comma separated string of key usage
496
+ * @description
497
+ * This method will get key usage extension value
498
+ * as comma separated string of usage names.
499
+ * If there is no key usage extension in the certificate,
500
+ * it returns empty string (i.e. '').
501
+ * @example
502
+ * x = new X509();
503
+ * x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
504
+ * x.getExtKeyUsageString() → "digitalSignature,keyEncipherment"
505
+ */
506
+ getExtKeyUsageString(): string;
507
+ /**
508
+ * get subjectKeyIdentifier value as hexadecimal string in the certificate
509
+ * @return hexadecimal string of subject key identifier or null
510
+ * @description
511
+ * This method will get subject key identifier extension value
512
+ * as hexadecimal string.
513
+ * If there is this in the certificate, it returns undefined;
514
+ * @example
515
+ * x = new X509();
516
+ * x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
517
+ * x.getExtSubjectKeyIdentifier() → "1b3347ab...";
518
+ */
519
+ getExtSubjectKeyIdentifier(): string;
520
+ /**
521
+ * get authorityKeyIdentifier value as JSON object in the certificate
522
+ * @return JSON object of authority key identifier or null
523
+ * @description
524
+ * This method will get authority key identifier extension value
525
+ * as JSON object.
526
+ * If there is this in the certificate, it returns undefined;
527
+ *
528
+ * NOTE: Currently this method only supports keyIdentifier so that
529
+ * authorityCertIssuer and authorityCertSerialNumber will not
530
+ * be return in the JSON object.
531
+ * @example
532
+ * x = new X509();
533
+ * x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
534
+ * x.getExtAuthorityKeyIdentifier() → { kid: "1234abcd..." }
535
+ */
536
+ getExtAuthorityKeyIdentifier(): {
537
+ kid: string;
538
+ } | null;
539
+ /**
540
+ * get extKeyUsage value as array of name string in the certificate
541
+ * @return array of extended key usage ID name or oid
542
+ * @description
543
+ * This method will get extended key usage extension value
544
+ * as array of name or OID string.
545
+ * If there is this in the certificate, it returns undefined;
546
+ *
547
+ * NOTE: Supported extended key usage ID names are defined in
548
+ * name2oidList parameter in asn1x509.js file.
549
+ * @example
550
+ * x = new X509();
551
+ * x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
552
+ * x.getExtExtKeyUsageName() → ["serverAuth", "clientAuth", "0.1.2.3.4.5"]
553
+ */
554
+ getExtExtKeyUsageName(): string[];
555
+ /**
556
+ * get subjectAltName value as array of string in the certificate
557
+ * @return array of alt name array
558
+ * @description
559
+ * This method will get subject alt name extension value
560
+ * as array of type and name.
561
+ * If there is this in the certificate, it returns undefined;
562
+ * Type of GeneralName will be shown as following:
563
+ *
564
+ * - "MAIL" - [1]rfc822Name
565
+ * - "DNS" - [2]dNSName
566
+ * - "DN" - [4]directoryName
567
+ * - "URI" - [6]uniformResourceIdentifier
568
+ * - "IP" - [7]iPAddress
569
+ *
570
+ * @example
571
+ * x = new X509();
572
+ * x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
573
+ * x.getExtSubjectAltName2() →
574
+ * [["DNS", "example.com"],
575
+ * ["DNS", "example.org"],
576
+ * ["MAIL", "foo@example.com"],
577
+ * ["IP", "192.168.1.1"],
578
+ * ["DN", "/C=US/O=TEST1"]]
579
+ */
580
+ getExtSubjectAltName2(): string[][] | undefined;
581
+ /**
582
+ * get array of string for fullName URIs in cRLDistributionPoints(CDP) in the certificate
583
+ * @return array of fullName URIs of CDP of the certificate
584
+ * @description
585
+ * This method will get all fullName URIs of cRLDistributionPoints extension
586
+ * in the certificate as array of URI string.
587
+ * If there is this in the certificate, it returns undefined;
588
+ *
589
+ * NOTE: Currently this method supports only fullName URI so that
590
+ * other parameters will not be returned.
591
+ * @example
592
+ * x = new X509();
593
+ * x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
594
+ * x.getExtCRLDistributionPointsURI() →
595
+ * ["http://example.com/aaa.crl", "http://example.org/aaa.crl"]
596
+ */
597
+ getExtCRLDistributionPointsURI(): string[] | undefined;
598
+ /**
599
+ * get AuthorityInfoAccess extension value in the certificate as associative array
600
+ * @return associative array of AIA extension properties
601
+ * @description
602
+ * This method will get authority info access value
603
+ * as associate array which has following properties:
604
+ *
605
+ * - ocsp - array of string for OCSP responder URL
606
+ * - caissuer - array of string for caIssuer value (i.e. CA certificates URL)
607
+ *
608
+ * If there is this in the certificate, it returns undefined;
609
+ * @example
610
+ * x = new X509();
611
+ * x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
612
+ * x.getExtAIAInfo(hCert) →
613
+ * { ocsp: ["http://ocsp.foo.com"],
614
+ * caissuer: ["http://rep.foo.com/aaa.p8m"] }
615
+ */
616
+ getExtAIAInfo(): {
617
+ caissuer: string[];
618
+ ocsp: string[];
619
+ } | undefined;
620
+ /**
621
+ * get CertificatePolicies extension value in the certificate as array
622
+ * @return array of PolicyInformation JSON object
623
+ * @description
624
+ * This method will get certificate policies value
625
+ * as an array of JSON object which has following properties:
626
+ *
627
+ * - id -
628
+ * - cps - URI of certification practice statement
629
+ * - unotice - string of UserNotice explicitText
630
+ *
631
+ * If there is this extension in the certificate,
632
+ * it returns undefined;
633
+ * @example
634
+ * x = new X509();
635
+ * x.readCertPEM(sCertPEM); // parseExt() will also be called internally.
636
+ * x.getExtCertificatePolicies →
637
+ * [{ id: 1.2.3.4,
638
+ * cps: "http://example.com/cps",
639
+ * unotice: "explicit text" }]
640
+ */
641
+ getExtCertificatePolicies(): {
642
+ cps: string;
643
+ id: string;
644
+ unotice: string;
645
+ } | undefined;
646
+ /**
647
+ * read PEM formatted X.509 certificate from string.
648
+ * @param sCertPEM string for PEM formatted X.509 certificate
649
+ * @example
650
+ * x = new X509();
651
+ * x.readCertPEM(sCertPEM); // read certificate
652
+ */
653
+ readCertPEM(sCertPEM: string): void;
654
+ /**
655
+ * read a hexadecimal string of X.509 certificate
656
+ * @param sCertHex hexadecimal string of X.509 certificate
657
+ * @description
658
+ * NOTE: `X509#parseExt` will be called internally since jsrsasign 7.2.0.
659
+ * @example
660
+ * x = new X509();
661
+ * x.readCertHex("3082..."); // read certificate
662
+ */
663
+ readCertHex(sCertHex: string): void;
664
+ /**
665
+ * get certificate information as string.
666
+ * @return certificate information string
667
+ * @example
668
+ * x = new X509();
669
+ * x.readCertPEM(certPEM);
670
+ * console.log(x.getInfo());
671
+ * // this shows as following
672
+ * Basic Fields
673
+ * serial number: 02ac5c266a0b409b8f0b79f2ae462577
674
+ * signature algorithm: SHA1withRSA
675
+ * issuer: /C=US/O=DigiCert Inc/OU=www.digicert.com/CN=DigiCert High Assurance EV Root CA
676
+ * notBefore: 061110000000Z
677
+ * notAfter: 311110000000Z
678
+ * subject: /C=US/O=DigiCert Inc/OU=www.digicert.com/CN=DigiCert High Assurance EV Root CA
679
+ * subject public key info:
680
+ * key algorithm: RSA
681
+ * n=c6cce573e6fbd4bb...
682
+ * e=10001
683
+ * X509v3 Extensions:
684
+ * keyUsage CRITICAL:
685
+ * digitalSignature,keyCertSign,cRLSign
686
+ * basicConstraints CRITICAL:
687
+ * cA=true
688
+ * subjectKeyIdentifier :
689
+ * b13ec36903f8bf4701d498261a0802ef63642bc3
690
+ * authorityKeyIdentifier :
691
+ * kid=b13ec36903f8bf4701d498261a0802ef63642bc3
692
+ * signature algorithm: SHA1withRSA
693
+ * signature: 1c1a0697dcd79c9f...
694
+ */
695
+ getInfo(): string;
696
+ /**
697
+ * get distinguished name string in OpenSSL online format from hexadecimal string of ASN.1 DER X.500 name
698
+ * @param hex hexadecimal string of ASN.1 DER distinguished name
699
+ * @param idx index of hexadecimal string (DEFAULT=0)
700
+ * @return OpenSSL online format distinguished name
701
+ * @description
702
+ * This static method converts from a hexadecimal string of
703
+ * distinguished name (DN)
704
+ * specified by 'hex' and 'idx' to OpenSSL oneline string representation (ex. /C=US/O=a).
705
+ * @example
706
+ * X509.hex2dn("3031310b3...") → /C=US/O=a/CN=b2+OU=b1
707
+ */
708
+ static hex2dn(hex: string, idx: number): string;
709
+ /**
710
+ * get relative distinguished name string in OpenSSL online format from hexadecimal string of ASN.1 DER RDN
711
+ * @param hex hexadecimal string of ASN.1 DER concludes relative distinguished name
712
+ * @param idx index of hexadecimal string (DEFAULT=0)
713
+ * @return OpenSSL online format relative distinguished name
714
+ * @description
715
+ * This static method converts from a hexadecimal string of
716
+ * relative distinguished name (RDN)
717
+ * specified by 'hex' and 'idx' to LDAP string representation (ex. O=test+CN=test).
718
+ * NOTE: Multi-valued RDN is supported since jsnrsasign 6.2.2 x509 1.1.10.
719
+ * @example
720
+ * X509.hex2rdn("310a3008060355040a0c0161") → O=a
721
+ * X509.hex2rdn("31143008060355040a0c01613008060355040a0c0162") → O=a+O=b
722
+ */
723
+ static hex2rdn(hex: string, idx: number): string;
724
+ /**
725
+ * get string from hexadecimal string of ASN.1 DER AttributeTypeAndValue
726
+ * @param hex hexadecimal string of ASN.1 DER concludes AttributeTypeAndValue
727
+ * @param idx index of hexadecimal string (DEFAULT=0)
728
+ * @return string representation of AttributeTypeAndValue (ex. C=US)
729
+ * @description
730
+ * This static method converts from a hexadecimal string of AttributeTypeAndValue
731
+ * specified by 'hex' and 'idx' to LDAP string representation (ex. C=US).
732
+ * @example
733
+ * X509.hex2attrTypeValue("3008060355040a0c0161") → O=a
734
+ * X509.hex2attrTypeValue("300806035504060c0161") → C=a
735
+ * X509.hex2attrTypeValue("...3008060355040a0c0161...", 128) → O=a
736
+ */
737
+ static hex2attrTypeValue(hex: string, idx: number): string;
738
+ /**
739
+ * get RSA/DSA/ECDSA public key object from X.509 certificate hexadecimal string
740
+ * @param h hexadecimal string of X.509 certificate for RSA/ECDSA/DSA public key
741
+ * @return returns RSAKey/KJUR.crypto.{ECDSA,DSA} object of public key
742
+ */
743
+ static getPublicKeyFromCertHex(h: string): RSAKey | KJUR.crypto.DSA | KJUR.crypto.ECDSA;
744
+ /**
745
+ * get RSA/DSA/ECDSA public key object from PEM certificate string
746
+ * @param sCertPEM PEM formatted RSA/ECDSA/DSA X.509 certificate
747
+ * @return returns RSAKey/KJUR.crypto.{ECDSA,DSA} object of public key
748
+ * @description
749
+ * NOTE: DSA is also supported since x509 1.1.2.
750
+ */
751
+ static getPublicKeyFromCertPEM(sCertPEM: string): RSAKey | KJUR.crypto.DSA | KJUR.crypto.ECDSA;
752
+ /**
753
+ * get public key information from PEM certificate
754
+ * @param sCertPEM string of PEM formatted certificate
755
+ * @return hash of information for public key
756
+ * @description
757
+ * Resulted associative array has following properties:
758
+ *
759
+ * - algoid - hexadecimal string of OID of asymmetric key algorithm
760
+ * - algparam - hexadecimal string of OID of ECC curve name or null
761
+ * - keyhex - hexadecimal string of key in the certificate
762
+ *
763
+ * NOTE: X509v1 certificate is also supported since x509.js 1.1.9.
764
+ */
765
+ static getPublicKeyInfoPropOfCertPEM(sCertPEM: string): PublicKeyInfoPropOfCertPEMResult;
766
+ }
767
+ declare function sha256(message: string): string;
768
+ export { X509, RSAKey, sha256, pemtohex, hextopem, b64tohex, hex2b64 };