gps-plus-slam-app-framework 1.0.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.
Files changed (200) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +222 -0
  3. package/dist/alignment-lerper-D9BeDwZX.d.ts +29 -0
  4. package/dist/app-selectors-DyMzxCEC.d.ts +140 -0
  5. package/dist/ar/camera-blit-capture.d.ts +2 -0
  6. package/dist/ar/camera-blit-capture.js +253 -0
  7. package/dist/ar/capture-failure-tracker.d.ts +2 -0
  8. package/dist/ar/capture-failure-tracker.js +45 -0
  9. package/dist/ar/chromium-camera-access-workaround.d.ts +2 -0
  10. package/dist/ar/chromium-camera-access-workaround.js +32 -0
  11. package/dist/ar/depth-sampler.d.ts +3 -0
  12. package/dist/ar/depth-sampler.js +147 -0
  13. package/dist/ar/image-capture.d.ts +2 -0
  14. package/dist/ar/image-capture.js +152 -0
  15. package/dist/ar/index.d.ts +12 -0
  16. package/dist/ar/index.js +12 -0
  17. package/dist/ar/replay-scene.d.ts +2 -0
  18. package/dist/ar/replay-scene.js +325 -0
  19. package/dist/ar/scene-node-names.d.ts +2 -0
  20. package/dist/ar/scene-node-names.js +16 -0
  21. package/dist/ar/tracking-state.d.ts +2 -0
  22. package/dist/ar/tracking-state.js +164 -0
  23. package/dist/ar/webxr-session.d.ts +4 -0
  24. package/dist/ar/webxr-session.js +890 -0
  25. package/dist/ar/xr-camera-texture.d.ts +2 -0
  26. package/dist/ar/xr-camera-texture.js +39 -0
  27. package/dist/ar/xr-error-handler.d.ts +2 -0
  28. package/dist/ar/xr-error-handler.js +37 -0
  29. package/dist/ar-types-B-ORgk6Z.d.ts +82 -0
  30. package/dist/camera-blit-capture-DHuyrrxr.d.ts +108 -0
  31. package/dist/camera-follower-BMqPddxx.d.ts +29 -0
  32. package/dist/capture-failure-tracker-2Q6oI2uQ.d.ts +52 -0
  33. package/dist/chromium-camera-access-workaround-CU5zSKNr.d.ts +61 -0
  34. package/dist/community-license-key-ChZLCJyO.d.ts +21 -0
  35. package/dist/concurrency-p6gB30fT.d.ts +24 -0
  36. package/dist/css3d-renderer-manager-rgLMVAvd.d.ts +23 -0
  37. package/dist/depth-sampler-BNCtnEoP.d.ts +108 -0
  38. package/dist/failure-tracker-1sQ_Cgyw.d.ts +49 -0
  39. package/dist/file-system-BsQgYCU3.d.ts +128 -0
  40. package/dist/file-system-utils-5cWO8Xyv.d.ts +24 -0
  41. package/dist/format-file-size-onGq0k1Q.d.ts +24 -0
  42. package/dist/fused-path-DtqCSqJh.d.ts +25 -0
  43. package/dist/geo-types-Xx-LVcnw.d.ts +29 -0
  44. package/dist/gps-Ddzr2KlX.d.ts +54 -0
  45. package/dist/gps-compass-cubes-C-6JEnpR.d.ts +22 -0
  46. package/dist/gps-error-handler-VPuNOuf8.d.ts +40 -0
  47. package/dist/gps-event-markers-DpEy2qRd.d.ts +67 -0
  48. package/dist/h3-ref-point-CFhayNSZ.d.ts +59 -0
  49. package/dist/image-capture-2pKjYUS6.d.ts +130 -0
  50. package/dist/index.d.ts +56 -0
  51. package/dist/index.js +61 -0
  52. package/dist/leaflet-map-overlay-CvfQXTye.d.ts +114 -0
  53. package/dist/lerp-utils-87NWjUOD.d.ts +20 -0
  54. package/dist/licensing/community-license-key.d.ts +2 -0
  55. package/dist/licensing/community-license-key.js +21 -0
  56. package/dist/licensing/index.d.ts +2 -0
  57. package/dist/licensing/index.js +2 -0
  58. package/dist/list-formatter-DKQQVLcl.d.ts +14 -0
  59. package/dist/logger-B81iwxx0.d.ts +74 -0
  60. package/dist/map-overlay-DuiZuCTx.d.ts +153 -0
  61. package/dist/null-storage-backend-CsWvQwN8.d.ts +11 -0
  62. package/dist/opfs-storage-ChOzF_Wp.d.ts +181 -0
  63. package/dist/opfs-storage-backend-CVcmfJHN.d.ts +11 -0
  64. package/dist/permission-checker-jO2ziCWC.d.ts +146 -0
  65. package/dist/persistence-middleware-DrptY02i.d.ts +31 -0
  66. package/dist/recorder-slice-fcwAXrsh.d.ts +35 -0
  67. package/dist/recording-coordinator-DzflP07_.d.ts +81 -0
  68. package/dist/recording-options-BYUFX8iU.d.ts +166 -0
  69. package/dist/recording-replayer-oOzPITrd.d.ts +32 -0
  70. package/dist/ref-point-importer-B_wn5ABk.d.ts +62 -0
  71. package/dist/ref-point-loader-Pt1smgHS.d.ts +117 -0
  72. package/dist/ref-points/h3-ref-point.d.ts +2 -0
  73. package/dist/ref-points/h3-ref-point.js +74 -0
  74. package/dist/ref-points/index.d.ts +2 -0
  75. package/dist/ref-points/index.js +2 -0
  76. package/dist/ref-points-slice-tC-Wd6XJ.d.ts +48 -0
  77. package/dist/reference-points-CFWy8_wj.d.ts +68 -0
  78. package/dist/replay-engine-DuX316ae.d.ts +103 -0
  79. package/dist/replay-scene-DtUm6bsr.d.ts +109 -0
  80. package/dist/routing-slice-BlHTM8eh.d.ts +23 -0
  81. package/dist/scene-node-names-DPsaE2z3.d.ts +14 -0
  82. package/dist/sensors/gps-error-handler.d.ts +2 -0
  83. package/dist/sensors/gps-error-handler.js +53 -0
  84. package/dist/sensors/gps.d.ts +2 -0
  85. package/dist/sensors/gps.js +93 -0
  86. package/dist/sensors/index.d.ts +4 -0
  87. package/dist/sensors/index.js +4 -0
  88. package/dist/sensors/permission-checker.d.ts +2 -0
  89. package/dist/sensors/permission-checker.js +397 -0
  90. package/dist/state/app-selectors.d.ts +2 -0
  91. package/dist/state/app-selectors.js +35 -0
  92. package/dist/state/index.d.ts +17 -0
  93. package/dist/state/index.js +13 -0
  94. package/dist/state/persistence-middleware.d.ts +2 -0
  95. package/dist/state/persistence-middleware.js +71 -0
  96. package/dist/state/recorder-slice.d.ts +2 -0
  97. package/dist/state/recorder-slice.js +47 -0
  98. package/dist/state/recording-coordinator.d.ts +2 -0
  99. package/dist/state/recording-coordinator.js +150 -0
  100. package/dist/state/recording-options.d.ts +2 -0
  101. package/dist/state/recording-options.js +192 -0
  102. package/dist/state/recording-replayer.d.ts +2 -0
  103. package/dist/state/recording-replayer.js +39 -0
  104. package/dist/state/ref-points-slice.d.ts +2 -0
  105. package/dist/state/ref-points-slice.js +44 -0
  106. package/dist/state/replay-engine.d.ts +2 -0
  107. package/dist/state/replay-engine.js +230 -0
  108. package/dist/state/routing-slice.d.ts +2 -0
  109. package/dist/state/routing-slice.js +13 -0
  110. package/dist/state/store-subscribers.d.ts +3 -0
  111. package/dist/state/store-subscribers.js +97 -0
  112. package/dist/state/store.d.ts +9 -0
  113. package/dist/state/store.js +71 -0
  114. package/dist/state/subscribe-to-selector.d.ts +2 -0
  115. package/dist/state/subscribe-to-selector.js +26 -0
  116. package/dist/storage/file-system-utils.d.ts +2 -0
  117. package/dist/storage/file-system-utils.js +31 -0
  118. package/dist/storage/file-system.d.ts +2 -0
  119. package/dist/storage/file-system.js +229 -0
  120. package/dist/storage/index.d.ts +11 -0
  121. package/dist/storage/index.js +10 -0
  122. package/dist/storage/null-storage-backend.d.ts +2 -0
  123. package/dist/storage/null-storage-backend.js +8 -0
  124. package/dist/storage/opfs-storage-backend.d.ts +2 -0
  125. package/dist/storage/opfs-storage-backend.js +15 -0
  126. package/dist/storage/opfs-storage.d.ts +2 -0
  127. package/dist/storage/opfs-storage.js +242 -0
  128. package/dist/storage/ref-point-importer.d.ts +2 -0
  129. package/dist/storage/ref-point-importer.js +163 -0
  130. package/dist/storage/ref-point-loader.d.ts +2 -0
  131. package/dist/storage/ref-point-loader.js +248 -0
  132. package/dist/storage/ref-point-recovery.d.ts +28 -0
  133. package/dist/storage/ref-point-recovery.js +159 -0
  134. package/dist/storage/storage-backend.d.ts +2 -0
  135. package/dist/storage/storage-backend.js +1 -0
  136. package/dist/storage/zip-export.d.ts +2 -0
  137. package/dist/storage/zip-export.js +214 -0
  138. package/dist/storage/zip-reader.d.ts +2 -0
  139. package/dist/storage/zip-reader.js +190 -0
  140. package/dist/storage-backend-BcEItnFr.d.ts +20 -0
  141. package/dist/store-C7PKOj8S.d.ts +96 -0
  142. package/dist/store-subscribers-CuoIzB5T.d.ts +77 -0
  143. package/dist/subscribe-to-selector-UTZ0KkAc.d.ts +26 -0
  144. package/dist/test-utils/browser-mocks.d.ts +294 -0
  145. package/dist/test-utils/browser-mocks.js +568 -0
  146. package/dist/test-utils/zip-round-trip-helpers.d.ts +60 -0
  147. package/dist/test-utils/zip-round-trip-helpers.js +207 -0
  148. package/dist/three-dispose-CCBHjE_a.d.ts +30 -0
  149. package/dist/tracking-state-B9QfuZCg.d.ts +101 -0
  150. package/dist/types/ar-types.d.ts +2 -0
  151. package/dist/types/ar-types.js +1 -0
  152. package/dist/types/geo-types.d.ts +2 -0
  153. package/dist/types/geo-types.js +1 -0
  154. package/dist/types/index.d.ts +3 -0
  155. package/dist/types/index.js +1 -0
  156. package/dist/utils/concurrency.d.ts +2 -0
  157. package/dist/utils/concurrency.js +40 -0
  158. package/dist/utils/failure-tracker.d.ts +2 -0
  159. package/dist/utils/failure-tracker.js +48 -0
  160. package/dist/utils/format-file-size.d.ts +2 -0
  161. package/dist/utils/format-file-size.js +41 -0
  162. package/dist/utils/fused-path.d.ts +2 -0
  163. package/dist/utils/fused-path.js +44 -0
  164. package/dist/utils/index.d.ts +7 -0
  165. package/dist/utils/index.js +7 -0
  166. package/dist/utils/list-formatter.d.ts +2 -0
  167. package/dist/utils/list-formatter.js +17 -0
  168. package/dist/utils/logger.d.ts +2 -0
  169. package/dist/utils/logger.js +226 -0
  170. package/dist/vis-colors-Qi2vlRGt.d.ts +63 -0
  171. package/dist/visualization/alignment-lerper.d.ts +2 -0
  172. package/dist/visualization/alignment-lerper.js +68 -0
  173. package/dist/visualization/camera-follower.d.ts +2 -0
  174. package/dist/visualization/camera-follower.js +51 -0
  175. package/dist/visualization/css3d-renderer-manager.d.ts +2 -0
  176. package/dist/visualization/css3d-renderer-manager.js +41 -0
  177. package/dist/visualization/gps-compass-cubes.d.ts +2 -0
  178. package/dist/visualization/gps-compass-cubes.js +129 -0
  179. package/dist/visualization/gps-event-markers.d.ts +2 -0
  180. package/dist/visualization/gps-event-markers.js +159 -0
  181. package/dist/visualization/index.d.ts +12 -0
  182. package/dist/visualization/index.js +12 -0
  183. package/dist/visualization/leaflet-map-overlay.d.ts +2 -0
  184. package/dist/visualization/leaflet-map-overlay.js +313 -0
  185. package/dist/visualization/lerp-utils.d.ts +2 -0
  186. package/dist/visualization/lerp-utils.js +22 -0
  187. package/dist/visualization/map-overlay.d.ts +2 -0
  188. package/dist/visualization/map-overlay.js +241 -0
  189. package/dist/visualization/reference-points.d.ts +2 -0
  190. package/dist/visualization/reference-points.js +160 -0
  191. package/dist/visualization/three-dispose.d.ts +2 -0
  192. package/dist/visualization/three-dispose.js +55 -0
  193. package/dist/visualization/vis-colors.d.ts +2 -0
  194. package/dist/visualization/vis-colors.js +74 -0
  195. package/dist/webxr-session-COlSrXdL.d.ts +316 -0
  196. package/dist/xr-camera-texture-BbukNE79.d.ts +53 -0
  197. package/dist/xr-error-handler-DTHfmvrl.d.ts +24 -0
  198. package/dist/zip-export-Rtpi75JJ.d.ts +87 -0
  199. package/dist/zip-reader-D7pkpX8K.d.ts +97 -0
  200. package/package.json +104 -0
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to the Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by the Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding any notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. Please also get an
185
+ "Alarm" or "alarm" from Alarm.com or its original author
186
+ of this boilerplate, which can be obtained from
187
+ http://www.apache.org/licenses/.
188
+
189
+ Copyright 2026 cs-util-com
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,222 @@
1
+ # GPS+SLAM App Framework
2
+
3
+ Reusable building blocks for AR+GPS applications built on [gps-plus-slam-js](https://www.npmjs.com/package/gps-plus-slam-js).
4
+
5
+ This library provides WebXR session management, Three.js visualization, GPS sensor coordination, storage abstractions, a replay engine, and store wiring — everything a web-based AR+GPS app needs beyond the core alignment algorithms.
6
+
7
+ ## Architecture
8
+
9
+ ```
10
+ ┌──────────────────────────────────────────────────┐
11
+ │ Your App │
12
+ │ (UI, screen flow, app-specific logic) │
13
+ ├──────────────────────────────────────────────────┤
14
+ │ gps-plus-slam-app-framework ← this package │
15
+ │ (WebXR, Three.js, sensors, storage, replay) │
16
+ ├──────────────────────────────────────────────────┤
17
+ │ gps-plus-slam-js (core algorithms) │
18
+ │ (GPS/AR alignment, outlier rejection, GPS math) │
19
+ └──────────────────────────────────────────────────┘
20
+ ```
21
+
22
+ The framework never imports from your app. Your app imports from the framework and the core library. The core library never imports from the framework.
23
+
24
+ ## Installation
25
+
26
+ ```bash
27
+ npm install gps-plus-slam-app-framework gps-plus-slam-js
28
+ ```
29
+
30
+ ### Peer Dependencies
31
+
32
+ Required:
33
+
34
+ - `three` (>= 0.170.0)
35
+ - `@zip.js/zip.js` (>= 2.7.0)
36
+ - `h3-js` (>= 4.0.0)
37
+ - `@reduxjs/toolkit` (>= 2.9.0)
38
+
39
+ Optional:
40
+
41
+ - `leaflet` (>= 1.9.0) — only needed if using `LeafletMapOverlay`
42
+ - `@sentry/browser` (>= 10.0.0) — only needed for error reporting integration
43
+
44
+ ## Quick Start
45
+
46
+ ```typescript
47
+ import { createRecorderStore } from 'gps-plus-slam-app-framework/state';
48
+ import { initAR } from 'gps-plus-slam-app-framework/ar';
49
+ import { startGpsWatch } from 'gps-plus-slam-app-framework/sensors';
50
+ import { wireStoreSubscribers } from 'gps-plus-slam-app-framework/state';
51
+ import { LeafletMapOverlay } from 'gps-plus-slam-app-framework/visualization';
52
+
53
+ // 1. Create store (wraps gps-plus-slam-js store with app-level slices)
54
+ const store = createRecorderStore();
55
+
56
+ // 2. Start GPS
57
+ startGpsWatch(
58
+ (pos) => {
59
+ /* feed position to recording coordinator */
60
+ },
61
+ (err) => {
62
+ /* handle error */
63
+ }
64
+ );
65
+
66
+ // 3. Start WebXR AR session
67
+ const container = document.getElementById('app')!;
68
+ await initAR(container);
69
+
70
+ // 4. Wire store → visualization
71
+ wireStoreSubscribers(store, {
72
+ /* visualization dependencies */
73
+ });
74
+ ```
75
+
76
+ Import from **subpaths** (e.g., `gps-plus-slam-app-framework/ar`) for clarity. The root barrel re-exports most symbols but some names overlap across modules.
77
+
78
+ ## Modules
79
+
80
+ ### `ar/` — WebXR & 3D Scene
81
+
82
+ WebXR session lifecycle, Three.js renderer setup, image/depth capture, and replay scene management.
83
+
84
+ | Export | Description |
85
+ | -------------------------------------------- | ------------------------------------------------ |
86
+ | `initAR(container)` | Start a WebXR AR session with Three.js rendering |
87
+ | `endARSession()` | End the active XR session |
88
+ | `startImageCapture()` / `stopImageCapture()` | Toggle camera frame capture |
89
+ | `startDepthCapture()` / `stopDepthCapture()` | Toggle depth sampling |
90
+ | `initReplayScene(container)` | Create a 3D replay scene with orbit/FPS controls |
91
+ | `ImageCaptureManager` | Configurable camera frame capture pipeline |
92
+ | `DepthSampler` | Depth buffer sampling with configurable grids |
93
+ | `CameraBlitCapture` | GPU blit-based camera capture |
94
+ | `TrackingStateManager` | AR tracking state monitoring |
95
+
96
+ ### `sensors/` — GPS & Permissions
97
+
98
+ GPS watch abstraction, device orientation, and permission probing.
99
+
100
+ | Export | Description |
101
+ | ----------------------------- | --------------------------------- |
102
+ | `startGpsWatch(onPos, onErr)` | Start watching GPS position |
103
+ | `stopGpsWatch()` | Stop GPS watch |
104
+ | `startOrientationWatch(cb)` | Start device orientation events |
105
+ | `checkAllPermissions()` | Probe camera, GPS, XR permissions |
106
+ | `requestAllPermissions()` | Request all needed permissions |
107
+ | `getGpsErrorMessage(code)` | Human-readable GPS error messages |
108
+
109
+ ### `state/` — Store & Recording
110
+
111
+ Combined Redux store factory, recording coordinator, replay engine, and store subscribers.
112
+
113
+ | Export | Description |
114
+ | ----------------------------------- | --------------------------------------------- |
115
+ | `createRecorderStore(options?)` | Create a combined store (core + app slices) |
116
+ | `startSession()` / `endSession()` | Session lifecycle actions |
117
+ | `recordGpsEvent(payload)` | Record a paired AR+GPS observation |
118
+ | `createGpsPositionHandler(config)` | Factory for GPS→store wiring |
119
+ | `ReplayEngine` | Timed action playback with pause/resume/speed |
120
+ | `replayRecording(store, blob)` | Replay a ZIP recording into a store |
121
+ | `wireStoreSubscribers(store, deps)` | Bridge store state → visualization updates |
122
+ | `loadRecordingOptions()` | Load persisted recording settings |
123
+ | `refPointsReducer` | Reference point state reducer |
124
+
125
+ ### `storage/` — OPFS, ZIP, File System
126
+
127
+ Storage abstractions, OPFS implementation, ZIP export/import, and reference point persistence.
128
+
129
+ | Export | Description |
130
+ | -------------------------------------- | ----------------------------------------------- |
131
+ | `StorageBackend` | Abstract storage interface (implement your own) |
132
+ | `OpfsStorageBackend` | OPFS-based `StorageBackend` implementation |
133
+ | `NullStorageBackend` | No-op backend for testing |
134
+ | `initOpfsStorage()` | Initialize OPFS directory structure |
135
+ | `initStorage(backend)` | Initialize the file-system layer |
136
+ | `exportSessionAsZip(handle)` | Export a recording session as a ZIP blob |
137
+ | `loadActionsFromZip(blob)` | Parse recorded actions from a ZIP file |
138
+ | `importRefPointsFromFolder(handle)` | Import reference points from prior sessions |
139
+ | `saveRefPointObservation(handle, obs)` | Persist a reference point observation |
140
+
141
+ ### `visualization/` — Three.js & Maps
142
+
143
+ Three.js markers, Leaflet map overlay, alignment interpolation, and camera controls.
144
+
145
+ | Export | Description |
146
+ | ------------------------------ | --------------------------------------------------- |
147
+ | `LeafletMapOverlay` | 2D Leaflet map integrated via CSS3D into a 3D scene |
148
+ | `MapOverlay` | Tile-based 3D map overlay (no Leaflet dependency) |
149
+ | `GpsEventVisualizer` | Three.js spheres for GPS event positions |
150
+ | `RefPointVisualizer` | Three.js spheres for reference points |
151
+ | `createAlignmentLerper()` | Smooth alignment matrix interpolation |
152
+ | `createCameraFollower()` | Camera that tracks a moving target |
153
+ | `createCss3dRendererManager()` | CSS3D renderer for HTML-in-3D overlays |
154
+ | `createGpsCompassCubes()` | Cardinal direction indicator cubes |
155
+ | `VIS_COLORS` | Consistent color palette for visualizations |
156
+ | `disposeObject3D(obj)` | Safe Three.js object disposal |
157
+
158
+ ### `ref-points/` — H3 Spatial Indexing
159
+
160
+ H3-based proximity matching for reference points.
161
+
162
+ | Export | Description |
163
+ | ------------------------------- | ------------------------------------------------ |
164
+ | `gpsToH3(lat, lon)` | Convert GPS coordinates to an H3 cell index |
165
+ | `findNearbyRefPoint(h3, known)` | Find a known reference point near an H3 cell |
166
+ | `H3_RESOLUTION` | The H3 resolution used (default: 12, ~10m cells) |
167
+
168
+ ### `utils/` — Logging & Helpers
169
+
170
+ | Export | Description |
171
+ | ------------------------------------------- | ------------------------------------------------ |
172
+ | `createLogger(channel)` | Create a channeled logger with level control |
173
+ | `computeFusedPath(inputs)` | Compute a fused GPS+odometry path |
174
+ | `createFailureTracker(config)` | Track failure rates with configurable thresholds |
175
+ | `mapWithConcurrencyLimit(items, fn, limit)` | Async map with bounded concurrency |
176
+ | `formatFileSize(bytes)` | Human-readable file sizes |
177
+
178
+ ### `types/` — Shared Type Definitions
179
+
180
+ AR and GPS type definitions (`DepthPoint`, `DepthSample`, etc.) used across modules.
181
+
182
+ ## Design Principles
183
+
184
+ 1. **No global singletons.** Everything is created via factories and passed explicitly.
185
+ 2. **Store is the integration point.** All modules communicate through Redux state.
186
+ 3. **Modules are optional.** Use `initAR` without `LeafletMapOverlay`. No forced coupling.
187
+ 4. **Swappable implementations.** The `StorageBackend` interface lets you replace OPFS with IndexedDB or a custom backend.
188
+
189
+ ## Development
190
+
191
+ ```bash
192
+ cd GpsPlusSlamJs_AppFramework
193
+ npm install
194
+ npm test # format + lint + typecheck + unit tests
195
+ npm run build # build with tsdown
196
+ ```
197
+
198
+ ### Project Structure
199
+
200
+ ```
201
+ src/
202
+ ├── ar/ # WebXR session, capture, replay scene
203
+ ├── sensors/ # GPS, orientation, permissions
204
+ ├── state/ # Redux store, recording coordinator, replay
205
+ ├── storage/ # OPFS, ZIP, file system, ref-point persistence
206
+ ├── ref-points/ # H3 spatial indexing
207
+ ├── visualization/ # Three.js markers, maps, camera helpers
208
+ ├── utils/ # Logger, concurrency, formatters
209
+ ├── types/ # Shared type definitions
210
+ └── test-utils/ # Test helpers (browser mocks, ZIP helpers)
211
+ ```
212
+
213
+ ## License
214
+
215
+ This framework is licensed under **Apache 2.0** — see [LICENSE](LICENSE).
216
+
217
+ > **Note:** This package depends on [gps-plus-slam-js](https://www.npmjs.com/package/gps-plus-slam-js), which is a **closed-source, proprietary** library distributed via npm under a separate license. A community license key is included in the open-source apps for frictionless development. See the core library's EULA for usage terms.
218
+
219
+ ## See Also
220
+
221
+ - [gps-plus-slam-js](https://www.npmjs.com/package/gps-plus-slam-js) — Core alignment algorithms (closed-source, UNLICENSED)
222
+ - [Recorder App](../GpsPlusSlamJs_RecorderApp/) — Full-featured recording app built on this framework
@@ -0,0 +1,29 @@
1
+ import * as THREE from "three";
2
+
3
+ //#region ../src/visualization/alignment-lerper.d.ts
4
+ interface AlignmentLerper {
5
+ /**
6
+ * Set the target alignment matrix. The arWorldGroup will lerp toward
7
+ * this target on subsequent update() calls.
8
+ *
9
+ * @param matrix 16-element column-major matrix (gl-matrix mat4 / Three.js toArray format)
10
+ */
11
+ setTarget(matrix: readonly number[]): void;
12
+ /**
13
+ * Advance the interpolation by dt seconds. Call once per frame.
14
+ *
15
+ * @param dt Delta time in seconds since last frame.
16
+ */
17
+ update(dt: number): void;
18
+ /** Lifecycle cleanup (no-op — lerper does not own arWorldGroup). */
19
+ dispose(): void;
20
+ }
21
+ /**
22
+ * Create an AlignmentLerper that drives arWorldGroup.matrix smoothly.
23
+ *
24
+ * @param arWorldGroup The group whose matrix is interpolated.
25
+ * @param lerpRate Lerp speed multiplier (default 8).
26
+ */
27
+ declare function createAlignmentLerper(arWorldGroup: THREE.Object3D, lerpRate?: number): AlignmentLerper;
28
+ //#endregion
29
+ export { createAlignmentLerper as n, AlignmentLerper as t };
@@ -0,0 +1,140 @@
1
+ import { n as CombinedRootState } from "./store-C7PKOj8S.js";
2
+ import * as _$_reduxjs_toolkit0 from "@reduxjs/toolkit";
3
+ import * as _$gps_plus_slam_js0 from "gps-plus-slam-js";
4
+ import { GpsPoint, LatLong, Matrix4, Quaternion, ReferencePoint, Vector3 } from "gps-plus-slam-js";
5
+
6
+ //#region ../src/state/app-selectors.d.ts
7
+ /** Alignment matrix (4×4), or null if not yet computed. */
8
+ declare const selectAlignmentMatrix: ((state: CombinedRootState) => Matrix4 | null) & {
9
+ clearCache: () => void;
10
+ resultsCount: () => number;
11
+ resetResultsCount: () => void;
12
+ } & {
13
+ resultFunc: (resultFuncArgs_0: _$gps_plus_slam_js0.GpsModel | null) => Matrix4 | null;
14
+ memoizedResultFunc: ((resultFuncArgs_0: _$gps_plus_slam_js0.GpsModel | null) => Matrix4 | null) & {
15
+ clearCache: () => void;
16
+ resultsCount: () => number;
17
+ resetResultsCount: () => void;
18
+ };
19
+ lastResult: () => Matrix4 | null;
20
+ dependencies: [(state: CombinedRootState) => _$gps_plus_slam_js0.GpsModel | null];
21
+ recomputations: () => number;
22
+ resetRecomputations: () => void;
23
+ dependencyRecomputations: () => number;
24
+ resetDependencyRecomputations: () => void;
25
+ } & {
26
+ memoize: typeof _$_reduxjs_toolkit0.weakMapMemoize;
27
+ argsMemoize: typeof _$_reduxjs_toolkit0.weakMapMemoize;
28
+ };
29
+ /** Recorded GPS positions with metadata. */
30
+ declare const selectGpsPositions: ((state: CombinedRootState) => readonly GpsPoint[]) & {
31
+ clearCache: () => void;
32
+ resultsCount: () => number;
33
+ resetResultsCount: () => void;
34
+ } & {
35
+ resultFunc: (resultFuncArgs_0: _$gps_plus_slam_js0.GpsModel | null) => readonly GpsPoint[];
36
+ memoizedResultFunc: ((resultFuncArgs_0: _$gps_plus_slam_js0.GpsModel | null) => readonly GpsPoint[]) & {
37
+ clearCache: () => void;
38
+ resultsCount: () => number;
39
+ resetResultsCount: () => void;
40
+ };
41
+ lastResult: () => readonly GpsPoint[];
42
+ dependencies: [(state: CombinedRootState) => _$gps_plus_slam_js0.GpsModel | null];
43
+ recomputations: () => number;
44
+ resetRecomputations: () => void;
45
+ dependencyRecomputations: () => number;
46
+ resetDependencyRecomputations: () => void;
47
+ } & {
48
+ memoize: typeof _$_reduxjs_toolkit0.weakMapMemoize;
49
+ argsMemoize: typeof _$_reduxjs_toolkit0.weakMapMemoize;
50
+ };
51
+ /** Recorded odometry positions (AR-local space). */
52
+ declare const selectOdometryPositions: ((state: CombinedRootState) => readonly Vector3[]) & {
53
+ clearCache: () => void;
54
+ resultsCount: () => number;
55
+ resetResultsCount: () => void;
56
+ } & {
57
+ resultFunc: (resultFuncArgs_0: _$gps_plus_slam_js0.GpsModel | null) => readonly Vector3[];
58
+ memoizedResultFunc: ((resultFuncArgs_0: _$gps_plus_slam_js0.GpsModel | null) => readonly Vector3[]) & {
59
+ clearCache: () => void;
60
+ resultsCount: () => number;
61
+ resetResultsCount: () => void;
62
+ };
63
+ lastResult: () => readonly Vector3[];
64
+ dependencies: [(state: CombinedRootState) => _$gps_plus_slam_js0.GpsModel | null];
65
+ recomputations: () => number;
66
+ resetRecomputations: () => void;
67
+ dependencyRecomputations: () => number;
68
+ resetDependencyRecomputations: () => void;
69
+ } & {
70
+ memoize: typeof _$_reduxjs_toolkit0.weakMapMemoize;
71
+ argsMemoize: typeof _$_reduxjs_toolkit0.weakMapMemoize;
72
+ };
73
+ /** Recorded odometry rotations (AR-local space). */
74
+ declare const selectOdometryRotations: ((state: CombinedRootState) => readonly Quaternion[]) & {
75
+ clearCache: () => void;
76
+ resultsCount: () => number;
77
+ resetResultsCount: () => void;
78
+ } & {
79
+ resultFunc: (resultFuncArgs_0: _$gps_plus_slam_js0.GpsModel | null) => readonly Quaternion[];
80
+ memoizedResultFunc: ((resultFuncArgs_0: _$gps_plus_slam_js0.GpsModel | null) => readonly Quaternion[]) & {
81
+ clearCache: () => void;
82
+ resultsCount: () => number;
83
+ resetResultsCount: () => void;
84
+ };
85
+ lastResult: () => readonly Quaternion[];
86
+ dependencies: [(state: CombinedRootState) => _$gps_plus_slam_js0.GpsModel | null];
87
+ recomputations: () => number;
88
+ resetRecomputations: () => void;
89
+ dependencyRecomputations: () => number;
90
+ resetDependencyRecomputations: () => void;
91
+ } & {
92
+ memoize: typeof _$_reduxjs_toolkit0.weakMapMemoize;
93
+ argsMemoize: typeof _$_reduxjs_toolkit0.weakMapMemoize;
94
+ };
95
+ /** GPS zero reference (origin for coordinate conversion), or null. */
96
+ declare const selectZeroReference: ((state: CombinedRootState) => LatLong | null) & {
97
+ clearCache: () => void;
98
+ resultsCount: () => number;
99
+ resetResultsCount: () => void;
100
+ } & {
101
+ resultFunc: (resultFuncArgs_0: _$gps_plus_slam_js0.GpsModel | null) => LatLong | null;
102
+ memoizedResultFunc: ((resultFuncArgs_0: _$gps_plus_slam_js0.GpsModel | null) => LatLong | null) & {
103
+ clearCache: () => void;
104
+ resultsCount: () => number;
105
+ resetResultsCount: () => void;
106
+ };
107
+ lastResult: () => LatLong | null;
108
+ dependencies: [(state: CombinedRootState) => _$gps_plus_slam_js0.GpsModel | null];
109
+ recomputations: () => number;
110
+ resetRecomputations: () => void;
111
+ dependencyRecomputations: () => number;
112
+ resetDependencyRecomputations: () => void;
113
+ } & {
114
+ memoize: typeof _$_reduxjs_toolkit0.weakMapMemoize;
115
+ argsMemoize: typeof _$_reduxjs_toolkit0.weakMapMemoize;
116
+ };
117
+ /** User-defined reference points for ground truth validation. */
118
+ declare const selectReferencePoints: ((state: CombinedRootState) => readonly ReferencePoint[]) & {
119
+ clearCache: () => void;
120
+ resultsCount: () => number;
121
+ resetResultsCount: () => void;
122
+ } & {
123
+ resultFunc: (resultFuncArgs_0: _$gps_plus_slam_js0.GpsModel | null) => readonly ReferencePoint[];
124
+ memoizedResultFunc: ((resultFuncArgs_0: _$gps_plus_slam_js0.GpsModel | null) => readonly ReferencePoint[]) & {
125
+ clearCache: () => void;
126
+ resultsCount: () => number;
127
+ resetResultsCount: () => void;
128
+ };
129
+ lastResult: () => readonly ReferencePoint[];
130
+ dependencies: [(state: CombinedRootState) => _$gps_plus_slam_js0.GpsModel | null];
131
+ recomputations: () => number;
132
+ resetRecomputations: () => void;
133
+ dependencyRecomputations: () => number;
134
+ resetDependencyRecomputations: () => void;
135
+ } & {
136
+ memoize: typeof _$_reduxjs_toolkit0.weakMapMemoize;
137
+ argsMemoize: typeof _$_reduxjs_toolkit0.weakMapMemoize;
138
+ };
139
+ //#endregion
140
+ export { selectReferencePoints as a, selectOdometryRotations as i, selectGpsPositions as n, selectZeroReference as o, selectOdometryPositions as r, selectAlignmentMatrix as t };
@@ -0,0 +1,2 @@
1
+ import { i as computeCaptureSize, n as CameraBlitCaptureConfig, r as DEFAULT_BLIT_CONFIG, t as CameraBlitCapture } from "../camera-blit-capture-DHuyrrxr.js";
2
+ export { CameraBlitCapture, CameraBlitCaptureConfig, DEFAULT_BLIT_CONFIG, computeCaptureSize };