@uptimizr/playcanvas 0.1.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 (49) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +193 -0
  3. package/dist/collector.d.ts +259 -0
  4. package/dist/collector.d.ts.map +1 -0
  5. package/dist/collector.js +1081 -0
  6. package/dist/collector.js.map +1 -0
  7. package/dist/connector.d.ts +17 -0
  8. package/dist/connector.d.ts.map +1 -0
  9. package/dist/connector.js +30 -0
  10. package/dist/connector.js.map +1 -0
  11. package/dist/device.d.ts +17 -0
  12. package/dist/device.d.ts.map +1 -0
  13. package/dist/device.js +40 -0
  14. package/dist/device.js.map +1 -0
  15. package/dist/graphics.d.ts +16 -0
  16. package/dist/graphics.d.ts.map +1 -0
  17. package/dist/graphics.js +57 -0
  18. package/dist/graphics.js.map +1 -0
  19. package/dist/index.d.ts +27 -0
  20. package/dist/index.d.ts.map +1 -0
  21. package/dist/index.js +23 -0
  22. package/dist/index.js.map +1 -0
  23. package/dist/proxy.d.ts +46 -0
  24. package/dist/proxy.d.ts.map +1 -0
  25. package/dist/proxy.js +225 -0
  26. package/dist/proxy.js.map +1 -0
  27. package/dist/raycast.d.ts +68 -0
  28. package/dist/raycast.d.ts.map +1 -0
  29. package/dist/raycast.js +163 -0
  30. package/dist/raycast.js.map +1 -0
  31. package/dist/renderer.d.ts +48 -0
  32. package/dist/renderer.d.ts.map +1 -0
  33. package/dist/renderer.js +62 -0
  34. package/dist/renderer.js.map +1 -0
  35. package/dist/scene.d.ts +21 -0
  36. package/dist/scene.d.ts.map +1 -0
  37. package/dist/scene.js +51 -0
  38. package/dist/scene.js.map +1 -0
  39. package/dist/trackScene.d.ts +114 -0
  40. package/dist/trackScene.d.ts.map +1 -0
  41. package/dist/trackScene.js +72 -0
  42. package/dist/trackScene.js.map +1 -0
  43. package/dist/uptimizr-playcanvas.global.js +66 -0
  44. package/dist/uptimizr-playcanvas.js +66 -0
  45. package/dist/vec.d.ts +10 -0
  46. package/dist/vec.d.ts.map +1 -0
  47. package/dist/vec.js +9 -0
  48. package/dist/vec.js.map +1 -0
  49. package/package.json +64 -0
@@ -0,0 +1,72 @@
1
+ import { UptimizrClient } from "@uptimizr/sdk-core";
2
+ import { playcanvasCollector } from "./collector.js";
3
+ import { readDeviceCaps } from "./device.js";
4
+ import { readGraphics } from "./graphics.js";
5
+ import { readConnector } from "./connector.js";
6
+ import { readSceneMeta } from "./scene.js";
7
+ /**
8
+ * One-call PlayCanvas integration: create a client, register the PlayCanvas
9
+ * collector, read device/GPU caps, and start the session. Returns the
10
+ * {@link UptimizrClient} so the host can read `sessionId`, emit custom events, or
11
+ * `stop()` on teardown.
12
+ *
13
+ * PlayCanvas supports multiple camera entities with no single "active" camera, and
14
+ * the connector reads FPS / the canvas from the app's graphics device, so — unlike
15
+ * Babylon's `trackScene(scene, options)` — the `camera` Entity is an explicit
16
+ * positional argument (mirroring the three connector).
17
+ *
18
+ * ```ts
19
+ * import { trackScene } from "@uptimizr/playcanvas";
20
+ *
21
+ * const client = trackScene(app, cameraEntity, {
22
+ * projectId: "your-project",
23
+ * endpoint: "https://collect.example.com",
24
+ * });
25
+ * // ... later
26
+ * await client.stop("manual");
27
+ * ```
28
+ *
29
+ * For finer control (custom transport, `beforeSend`, registering multiple
30
+ * collectors), use {@link playcanvasCollector} with a {@link UptimizrClient} directly.
31
+ */
32
+ export function trackScene(app, camera, options) {
33
+ const client = new UptimizrClient({
34
+ projectId: options.projectId,
35
+ endpoint: options.endpoint,
36
+ flushIntervalMs: options.flushIntervalMs,
37
+ transport: options.transport,
38
+ disabled: options.disabled,
39
+ debug: options.debug,
40
+ });
41
+ client.use(playcanvasCollector({
42
+ app,
43
+ camera,
44
+ sampleCameraMs: options.sampleCameraMs,
45
+ samplePerfMs: options.samplePerfMs,
46
+ pointerMoveThrottleMs: options.pointerMoveThrottleMs,
47
+ suppressIdleSamples: options.suppressIdleSamples,
48
+ suppressIdlePerfSamples: options.suppressIdlePerfSamples,
49
+ cameraEpsilon: options.cameraEpsilon,
50
+ perfFpsThreshold: options.perfFpsThreshold,
51
+ capture: options.capture,
52
+ ...(options.gaze ? { gaze: options.gaze } : {}),
53
+ ...(options.sampling ? { sampling: options.sampling } : {}),
54
+ ...(options.actors ? { actors: options.actors } : {}),
55
+ ...(options.keyBindings ? { keyBindings: options.keyBindings } : {}),
56
+ }));
57
+ const sceneMeta = {
58
+ ...readSceneMeta(app, camera),
59
+ ...(options.sceneDescription ? { description: options.sceneDescription } : {}),
60
+ ...(options.cameraType ? { cameraType: options.cameraType } : {}),
61
+ };
62
+ client.start({
63
+ device: readDeviceCaps(app),
64
+ graphics: readGraphics(app),
65
+ connector: readConnector(),
66
+ scene: sceneMeta,
67
+ ...(options.user ? { user: options.user } : {}),
68
+ ...options.meta,
69
+ });
70
+ return client;
71
+ }
72
+ //# sourceMappingURL=trackScene.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"trackScene.js","sourceRoot":"","sources":["../src/trackScene.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAKpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAMrD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAqF3C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,UAAU,CACxB,GAAY,EACZ,MAAc,EACd,OAA0B;IAE1B,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC;QAChC,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,eAAe,EAAE,OAAO,CAAC,eAAe;QACxC,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,KAAK,EAAE,OAAO,CAAC,KAAK;KACrB,CAAC,CAAC;IAEH,MAAM,CAAC,GAAG,CACR,mBAAmB,CAAC;QAClB,GAAG;QACH,MAAM;QACN,cAAc,EAAE,OAAO,CAAC,cAAc;QACtC,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,qBAAqB,EAAE,OAAO,CAAC,qBAAqB;QACpD,mBAAmB,EAAE,OAAO,CAAC,mBAAmB;QAChD,uBAAuB,EAAE,OAAO,CAAC,uBAAuB;QACxD,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;QAC1C,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/C,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrD,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACrE,CAAC,CACH,CAAC;IAEF,MAAM,SAAS,GAAG;QAChB,GAAG,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC;QAC7B,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9E,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAClE,CAAC;IAEF,MAAM,CAAC,KAAK,CAAC;QACX,MAAM,EAAE,cAAc,CAAC,GAAG,CAAC;QAC3B,QAAQ,EAAE,YAAY,CAAC,GAAG,CAAC;QAC3B,SAAS,EAAE,aAAa,EAAE;QAC1B,KAAK,EAAE,SAAS;QAChB,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/C,GAAG,OAAO,CAAC,IAAI;KAChB,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC"}