@mentra/miniapp 3.3.0 → 3.4.0-beta.1237

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 (74) hide show
  1. package/README.md +5 -5
  2. package/dist/background/index.d.ts +5 -2
  3. package/dist/background/index.d.ts.map +1 -1
  4. package/dist/background/index.js.map +1 -1
  5. package/dist/index.d.ts +5 -2
  6. package/dist/index.d.ts.map +1 -1
  7. package/dist/index.js.map +1 -1
  8. package/dist/modules/blob.d.ts +2 -1
  9. package/dist/modules/blob.d.ts.map +1 -1
  10. package/dist/modules/blob.js +2 -1
  11. package/dist/modules/blob.js.map +1 -1
  12. package/dist/modules/events.d.ts +16 -6
  13. package/dist/modules/events.d.ts.map +1 -1
  14. package/dist/modules/events.js +53 -47
  15. package/dist/modules/events.js.map +1 -1
  16. package/dist/modules/mic.d.ts +26 -4
  17. package/dist/modules/mic.d.ts.map +1 -1
  18. package/dist/modules/mic.js +13 -4
  19. package/dist/modules/mic.js.map +1 -1
  20. package/dist/modules/miniapps.d.ts +44 -57
  21. package/dist/modules/miniapps.d.ts.map +1 -1
  22. package/dist/modules/miniapps.js +21 -24
  23. package/dist/modules/miniapps.js.map +1 -1
  24. package/dist/modules/speaker.d.ts +41 -10
  25. package/dist/modules/speaker.d.ts.map +1 -1
  26. package/dist/modules/speaker.js +17 -6
  27. package/dist/modules/speaker.js.map +1 -1
  28. package/dist/modules/speechProcessing.d.ts +29 -0
  29. package/dist/modules/speechProcessing.d.ts.map +1 -0
  30. package/dist/modules/speechProcessing.js +22 -0
  31. package/dist/modules/speechProcessing.js.map +1 -0
  32. package/dist/modules/system.d.ts +8 -3
  33. package/dist/modules/system.d.ts.map +1 -1
  34. package/dist/modules/system.js +1 -1
  35. package/dist/modules/system.js.map +1 -1
  36. package/dist/modules/telemetry.d.ts +25 -0
  37. package/dist/modules/telemetry.d.ts.map +1 -0
  38. package/dist/modules/telemetry.js +61 -0
  39. package/dist/modules/telemetry.js.map +1 -0
  40. package/dist/modules/transcription.d.ts +70 -3
  41. package/dist/modules/transcription.d.ts.map +1 -1
  42. package/dist/modules/transcription.js +68 -2
  43. package/dist/modules/transcription.js.map +1 -1
  44. package/dist/protocol.d.ts +29 -15
  45. package/dist/protocol.d.ts.map +1 -1
  46. package/dist/protocol.js +30 -15
  47. package/dist/protocol.js.map +1 -1
  48. package/dist/react/MentraProvider.d.ts +13 -1
  49. package/dist/react/MentraProvider.d.ts.map +1 -1
  50. package/dist/react/MentraProvider.js +31 -1
  51. package/dist/react/MentraProvider.js.map +1 -1
  52. package/dist/session.d.ts +16 -3
  53. package/dist/session.d.ts.map +1 -1
  54. package/dist/session.js +6 -13
  55. package/dist/session.js.map +1 -1
  56. package/dist/ui/index.d.ts +7 -4
  57. package/dist/ui/index.d.ts.map +1 -1
  58. package/dist/ui/index.js.map +1 -1
  59. package/package.json +2 -2
  60. package/src/background/index.ts +6 -3
  61. package/src/index.ts +11 -3
  62. package/src/modules/blob.ts +2 -1
  63. package/src/modules/events.ts +65 -51
  64. package/src/modules/mic.ts +30 -4
  65. package/src/modules/miniapps.ts +59 -71
  66. package/src/modules/speaker.ts +56 -12
  67. package/src/modules/speechProcessing.ts +42 -0
  68. package/src/modules/system.ts +8 -3
  69. package/src/modules/telemetry.ts +62 -0
  70. package/src/modules/transcription.ts +106 -9
  71. package/src/protocol.ts +32 -16
  72. package/src/react/MentraProvider.tsx +23 -2
  73. package/src/session.ts +20 -17
  74. package/src/ui/index.ts +7 -4
@@ -1 +1 @@
1
- {"version":3,"file":"mic.d.ts","sourceRoot":"","sources":["../../src/modules/mic.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,OAAO,EAAC,cAAc,EAAC,MAAM,YAAY,CAAA;AACzC,OAAO,KAAK,EAAC,cAAc,EAAE,aAAa,EAAE,OAAO,EAAC,MAAM,UAAU,CAAA;AAEpE,kDAAkD;AAClD,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,OAAO,CAAA;AAElD,kFAAkF;AAClF,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAAG,eAAe,GAAG,iBAAiB,GAAG,YAAY,CAAA;AAEjG,kEAAkE;AAClE,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACzB;AAED,qBAAa,SAAS;IAIR,OAAO,CAAC,QAAQ,CAAC,OAAO;IAHpC,wEAAwE;IACxE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA2B;gBAErB,OAAO,EAAE,cAAc;IAEpD;;;OAGG;IACH,eAAe,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,GAAG,aAAa;IAIhE;;;OAGG;IACH,YAAY,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GAAG,aAAa;IAIpE;;;;;;;;OAQG;IACH,gCAAgC,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAOjE;;;;;;OAMG;IACH,sBAAsB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAOvD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,OAAO,CAAC,OAAO,EAAE;QAAC,MAAM,EAAE,gBAAgB,CAAC;QAAC,OAAO,EAAE,iBAAiB,CAAA;KAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;IA0BjG;;;;OAIG;IACH,IAAI,IAAI,IAAI;IAWZ,mEAAmE;IACnE,IAAI,aAAa,IAAI,OAAO,CAE3B;IAID,OAAO,CAAC,KAAK;CAOd"}
1
+ {"version":3,"file":"mic.d.ts","sourceRoot":"","sources":["../../src/modules/mic.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,OAAO,EAAC,cAAc,EAAC,MAAM,YAAY,CAAA;AACzC,OAAO,KAAK,EAAC,cAAc,EAAE,aAAa,EAAE,OAAO,EAAC,MAAM,UAAU,CAAA;AAEpE,kDAAkD;AAClD,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,OAAO,CAAA;AAElD,kFAAkF;AAClF,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAAG,eAAe,GAAG,iBAAiB,GAAG,YAAY,CAAA;AAEjG,kEAAkE;AAClE,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACzB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,SAAS,GAAG,OAAO,GAAG,UAAU,GAAG,OAAO,CAAA;IAChD,qEAAqE;IACrE,MAAM,EAAE,MAAM,CAAA;IACd,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,qBAAa,SAAS;IAIR,OAAO,CAAC,QAAQ,CAAC,OAAO;IAHpC,wEAAwE;IACxE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA2B;gBAErB,OAAO,EAAE,cAAc;IAEpD;;;;;OAKG;IACH,eAAe,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,GAAG,aAAa;IAIhE;;;;;;OAMG;IACH,UAAU,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,GAAG,aAAa;IAIlE,8EAA8E;IAC9E,YAAY,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GAAG,aAAa;IAIpE;;;;;;;;OAQG;IACH,gCAAgC,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAOjE;;;;;;OAMG;IACH,sBAAsB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAOvD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,OAAO,CAAC,OAAO,EAAE;QAAC,MAAM,EAAE,gBAAgB,CAAC;QAAC,OAAO,EAAE,iBAAiB,CAAA;KAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;IA0BjG;;;;OAIG;IACH,IAAI,IAAI,IAAI;IAWZ,mEAAmE;IACnE,IAAI,aAAa,IAAI,OAAO,CAE3B;IAID,OAAO,CAAC,KAAK;CAOd"}
@@ -22,16 +22,25 @@ export class MicModule {
22
22
  this.unsubs = new Set();
23
23
  }
24
24
  /**
25
- * Subscribe to voice activity detection (VAD) events. `data.status` is
26
- * `true` while the user is speaking, `false` when silent.
25
+ * Subscribe to on-device voice activity detection. One event when the user
26
+ * starts speaking (`status: true`) and one when they stop (`status: false`,
27
+ * with `silentForMs` saying how long the audio has already been quiet). A
28
+ * gap in microphone audio counts as silence. Requires MICROPHONE permission.
27
29
  */
28
30
  onVoiceActivity(handler) {
29
31
  return this.track(this.session._subscribe(MiniappStreamType.VAD, handler));
30
32
  }
31
33
  /**
32
- * Subscribe to raw audio chunks. Format depends on the phone's mic mode
33
- * (PCM or LC3, base64-encoded).
34
+ * Subscribe to the on-device "Hey Mentra" wake word. Every subscribed
35
+ * miniapp receives every detection. You get the detector's current state
36
+ * right away, then every change. The phone loads the wake-word model while
37
+ * any miniapp subscribes and downloads it on first use. Requires MICROPHONE
38
+ * permission.
34
39
  */
40
+ onWakeWord(handler) {
41
+ return this.track(this.session._subscribe(MiniappStreamType.WAKE_WORD, handler));
42
+ }
43
+ /** Subscribe to raw audio chunks in the phone's PCM/LC3 microphone format. */
35
44
  onAudioChunk(handler) {
36
45
  return this.track(this.session._subscribe(MiniappStreamType.AUDIO_CHUNK, handler));
37
46
  }
@@ -1 +1 @@
1
- {"version":3,"file":"mic.js","sourceRoot":"","sources":["../../src/modules/mic.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAC,kBAAkB,EAAE,iBAAiB,EAAC,MAAM,aAAa,CAAA;AAgBjE,MAAM,OAAO,SAAS;IAIpB,YAA6B,OAAuB;QAAvB,YAAO,GAAP,OAAO,CAAgB;QAHpD,wEAAwE;QACvD,WAAM,GAAG,IAAI,GAAG,EAAiB,CAAA;IAEK,CAAC;IAExD;;;OAGG;IACH,eAAe,CAAC,OAAgC;QAC9C,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,GAAG,EAAE,OAAkC,CAAC,CAAC,CAAA;IACvG,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,OAAuC;QAClD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,WAAW,EAAE,OAAkC,CAAC,CAAC,CAAA;IAC/G,CAAC;IAED;;;;;;;;OAQG;IACH,gCAAgC,CAAC,OAAgB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;YACpC,IAAI,EAAE,kBAAkB,CAAC,mBAAmB;YAC5C,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;OAMG;IACH,sBAAsB,CAAC,OAAgB;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;YACpC,IAAI,EAAE,kBAAkB,CAAC,6BAA6B;YACtD,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,OAAO,CAAC,OAA+D;QAC3E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAkC;YAC7E,IAAI,EAAE,kBAAkB,CAAC,WAAW;YACpC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAA;QACF,4FAA4F;QAC5F,sEAAsE;QACtE,IAAI,OAAO,MAAM,EAAE,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAA;QACxF,CAAC;QACD,MAAM,EAAC,SAAS,EAAC,GAAG,MAAM,CAAA;QAC1B,IAAI,QAAQ,GAAG,KAAK,CAAA;QACpB,OAAO;YACL,SAAS;YACT,OAAO,EAAE,KAAK,IAAI,EAAE;gBAClB,IAAI,QAAQ;oBAAE,OAAM;gBACpB,QAAQ,GAAG,IAAI,CAAA;gBACf,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;oBACnC,IAAI,EAAE,kBAAkB,CAAC,WAAW;oBACpC,SAAS;iBACV,CAAC,CAAA;YACJ,CAAC;SACF,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAC5B,IAAI,CAAC;gBACH,CAAC,EAAE,CAAA;YACL,CAAC;YAAC,MAAM,CAAC;gBACP,YAAY;YACd,CAAC;QACH,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;IACrB,CAAC;IAED,mEAAmE;IACnE,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAA;IAC1D,CAAC;IAED,2EAA2E;IAEnE,KAAK,CAAC,KAAoB;QAChC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QACtB,OAAO,GAAG,EAAE;YACV,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;YACzB,KAAK,EAAE,CAAA;QACT,CAAC,CAAA;IACH,CAAC;CACF"}
1
+ {"version":3,"file":"mic.js","sourceRoot":"","sources":["../../src/modules/mic.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAC,kBAAkB,EAAE,iBAAiB,EAAC,MAAM,aAAa,CAAA;AAgCjE,MAAM,OAAO,SAAS;IAIpB,YAA6B,OAAuB;QAAvB,YAAO,GAAP,OAAO,CAAgB;QAHpD,wEAAwE;QACvD,WAAM,GAAG,IAAI,GAAG,EAAiB,CAAA;IAEK,CAAC;IAExD;;;;;OAKG;IACH,eAAe,CAAC,OAAgC;QAC9C,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,GAAG,EAAE,OAAkC,CAAC,CAAC,CAAA;IACvG,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,OAAuC;QAChD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,SAAS,EAAE,OAAkC,CAAC,CAAC,CAAA;IAC7G,CAAC;IAED,8EAA8E;IAC9E,YAAY,CAAC,OAAuC;QAClD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,WAAW,EAAE,OAAkC,CAAC,CAAC,CAAA;IAC/G,CAAC;IAED;;;;;;;;OAQG;IACH,gCAAgC,CAAC,OAAgB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;YACpC,IAAI,EAAE,kBAAkB,CAAC,mBAAmB;YAC5C,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;OAMG;IACH,sBAAsB,CAAC,OAAgB;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;YACpC,IAAI,EAAE,kBAAkB,CAAC,6BAA6B;YACtD,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,OAAO,CAAC,OAA+D;QAC3E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAkC;YAC7E,IAAI,EAAE,kBAAkB,CAAC,WAAW;YACpC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,CAAC,CAAA;QACF,4FAA4F;QAC5F,sEAAsE;QACtE,IAAI,OAAO,MAAM,EAAE,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAA;QACxF,CAAC;QACD,MAAM,EAAC,SAAS,EAAC,GAAG,MAAM,CAAA;QAC1B,IAAI,QAAQ,GAAG,KAAK,CAAA;QACpB,OAAO;YACL,SAAS;YACT,OAAO,EAAE,KAAK,IAAI,EAAE;gBAClB,IAAI,QAAQ;oBAAE,OAAM;gBACpB,QAAQ,GAAG,IAAI,CAAA;gBACf,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;oBACnC,IAAI,EAAE,kBAAkB,CAAC,WAAW;oBACpC,SAAS;iBACV,CAAC,CAAA;YACJ,CAAC;SACF,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAC5B,IAAI,CAAC;gBACH,CAAC,EAAE,CAAA;YACL,CAAC;YAAC,MAAM,CAAC;gBACP,YAAY;YACd,CAAC;QACH,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;IACrB,CAAC;IAED,mEAAmE;IACnE,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAA;IAC1D,CAAC;IAED,2EAA2E;IAEnE,KAAK,CAAC,KAAoB;QAChC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QACtB,OAAO,GAAG,EAAE;YACV,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;YACzB,KAAK,EAAE,CAAA;QACT,CAAC,CAAA;IACH,CAAC;CACF"}
@@ -7,10 +7,12 @@
7
7
  * layer (invoke / handle) lives on `session.actions`, not here — these are
8
8
  * operations on the app as a whole, not on a declared action.
9
9
  *
10
- * Installation (`install`, `checkInstallCompatibility`, `uninstall`) is
11
- * narrower still: the host accepts it only from a Store miniapp bundled with
12
- * the Mentra App build. The host downloads, verifies, and activates the
13
- * release through its own installer; the Store only selects the release.
10
+ * Installing (`install`, `checkInstallCompatibility`, `uninstall`) is
11
+ * narrower still: only a miniapp on the Mentra App's system list, running the
12
+ * release the Mentra App installed for it, may install miniapps. Development
13
+ * builds, which may use the calls above, may not. The host installs from a
14
+ * miniapp URL through the same installer as every other way in, with no install
15
+ * sheet: the caller asks the person first.
14
16
  */
15
17
  import { MiniappSession } from "../session";
16
18
  /** A declared action surfaced by {@link MiniappsModule.list}. */
@@ -56,10 +58,6 @@ export interface MiniappInfo {
56
58
  compatibility: MiniappCompatibility;
57
59
  /** True when this package identity is backed by a ZIP in the Mentra App build. */
58
60
  system: boolean;
59
- /** Store package that owns updates of this active release, when it is Store-managed. */
60
- storeOwnerPackageName?: string;
61
- /** Store the host build assigns to update this bundled package's active release, if any. */
62
- systemStoreOwnerPackageName?: string;
63
61
  /** Declared actions (empty if the miniapp declares none). */
64
62
  actions: MiniappActionInfo[];
65
63
  }
@@ -72,47 +70,41 @@ export interface MiniappHardwareRequirement {
72
70
  level: string;
73
71
  description?: string;
74
72
  }
75
- /** Backend-neutral release request, accepted only from a bundled, host-trusted Store. */
73
+ /** A miniapp to install. */
76
74
  export interface InstallMiniappRequest {
77
- packageName: string;
78
- version: string;
79
- bundleUrl: string;
80
- /** SHA-256 of the release ZIP; the host refuses any other bytes. */
81
- bundleSha256: string;
82
- /**
83
- * Bearer for `bundleUrl`, when the Store's backend requires one. The host
84
- * forwards it untouched and keeps no Store address of its own: entitlement is
85
- * settled between this miniapp and its backend, integrity by the SHA-256 and
86
- * the bundle's publisher signature.
87
- */
88
- bundleAuthorization?: string;
75
+ /** The miniapp's URL: the HTTPS address that serves its `miniapp.json`. */
76
+ url: string;
89
77
  /**
90
- * Automatic update: never stop a running miniapp. A running or starting
91
- * target defers the request with `APP_RUNNING`.
78
+ * The package the person agreed to install. When given, a URL that serves another package installs nothing and
79
+ * fails with `not_a_miniapp`.
92
80
  */
93
- onlyIfStopped?: boolean;
94
- /**
95
- * With `onlyIfStopped`: when the target is running, the host stages the
96
- * release and asks the user whether to update now. Declining, or a prompt the
97
- * host does not show (the Mentra App is in the background, another prompt is
98
- * open, or this miniapp was asked within the last day), still answers
99
- * `APP_RUNNING`.
100
- */
101
- askIfRunning?: boolean;
102
- /** Minimum Mentra App version declared by the release manifest. */
103
- minHostVersion?: string;
104
- /** Mentra Miniapp SDK version declared by the release manifest. */
105
- sdkVersion?: string;
106
- /** Glasses hardware requirements declared by the release manifest. */
107
- hardwareRequirements?: MiniappHardwareRequirement[];
108
- releaseId?: string;
109
- channel?: string;
81
+ packageName?: string;
110
82
  }
111
83
  export interface InstallMiniappResult {
84
+ /**
85
+ * `installed`: this release installed. `opened`: nothing installed, because the miniapp is installed from this URL
86
+ * already, or a newer release of it is; {@link MiniappsModule.open} it to show it. `deferred`: the miniapp is
87
+ * running, so its update waits until it stops, or until the person answers the Mentra App's update prompt.
88
+ */
89
+ status: "installed" | "opened" | "deferred";
112
90
  packageName: string;
91
+ /** The installed version: the new release, or the one that stays. */
113
92
  version: string;
114
- installedByStore: string;
115
93
  }
94
+ /**
95
+ * Why an install failed: the `reason` of an `INSTALL_FAILED` rejection from {@link MiniappsModule.install}.
96
+ * - `not_a_miniapp`: the URL serves no valid `miniapp.json` or bundle.
97
+ * - `domain_mismatch`: the package name doesn't belong to the URL's domain.
98
+ * - `archived`: Mentra archived this URL; it doesn't install.
99
+ * - `needs_newer_app`: the miniapp needs a newer Mentra App, or hardware the glasses lack.
100
+ * - `access_denied`: its server refused this account, or this deployment doesn't allow installing from a URL.
101
+ * - `age_restricted`: the person's declared age is below the miniapp's age rating.
102
+ * - `network`: the URL couldn't be reached.
103
+ * - `cancelled`: the Mentra App signed out or switched deployments meanwhile.
104
+ * - `integrity`: the bundle doesn't match what `miniapp.json` names.
105
+ * - `signature_invalid`: the bundle's signature doesn't match the installed miniapp's publisher.
106
+ */
107
+ export type InstallMiniappFailureReason = "not_a_miniapp" | "domain_mismatch" | "archived" | "needs_newer_app" | "access_denied" | "age_restricted" | "network" | "cancelled" | "integrity" | "signature_invalid";
116
108
  export interface InstallMiniappCompatibilityRequest {
117
109
  minHostVersion?: string | null;
118
110
  sdkVersion?: string | null;
@@ -125,15 +117,8 @@ export type InstallMiniappCompatibility = {
125
117
  blocker: "host" | "sdk" | "hardware";
126
118
  reason: string;
127
119
  };
128
- export type InstallMiniappPhase = "downloading" | "verifying" | "extracting" | "activating" | "complete";
129
- export interface InstallMiniappProgress {
130
- packageName: string;
131
- version: string;
132
- phase: InstallMiniappPhase;
133
- }
134
120
  export declare class MiniappsModule {
135
121
  private readonly session;
136
- private readonly progressHandlers;
137
122
  constructor(session: MiniappSession);
138
123
  /**
139
124
  * List installed miniapps. Compatible-only by default; pass
@@ -154,18 +139,20 @@ export declare class MiniappsModule {
154
139
  /** Stop another miniapp. SYSTEM-only. */
155
140
  stop(packageName: string): Promise<void>;
156
141
  /**
157
- * Download, verify, and install a release through the phone host. Accepted
158
- * only from a Store bundled with the Mentra App build; other callers receive
159
- * NOT_PERMITTED.
142
+ * Install the miniapp at a miniapp URL, with no install sheet: ask the person first. The host fetches its
143
+ * `miniapp.json`, checks the package name against the URL's domain, registers the URL with Mentra, checks the
144
+ * phone can run it, and downloads, verifies and installs its bundle.
145
+ *
146
+ * Only a miniapp on the Mentra App's system list may install; any other caller gets NOT_PERMITTED. A failed
147
+ * install rejects with INSTALL_FAILED, whose `reason` is an {@link InstallMiniappFailureReason}.
160
148
  */
161
149
  install(request: InstallMiniappRequest): Promise<InstallMiniappResult>;
162
- /** Check host, Mentra Miniapp SDK, and glasses compatibility before offering or applying an update. */
150
+ /** Check a release's Mentra App, SDK and glasses requirements against this phone. System-list miniapps only. */
163
151
  checkInstallCompatibility(request: InstallMiniappCompatibilityRequest): Promise<InstallMiniappCompatibility>;
164
- /** Subscribe to host-owned install progress. Returns an unsubscribe function. */
165
- onInstallProgress(handler: (progress: InstallMiniappProgress) => void): () => void;
166
- /** @internal */
167
- _deliverInstallProgress(progress: InstallMiniappProgress): void;
168
- /** Uninstall a package this Store installed. Bundled Stores only. */
152
+ /**
153
+ * Uninstall a miniapp installed from a miniapp URL. A miniapp the Mentra App bundles, one a workspace manages and a
154
+ * development build stay, with NOT_PERMITTED. System-list miniapps only.
155
+ */
169
156
  uninstall(packageName: string): Promise<void>;
170
157
  }
171
158
  //# sourceMappingURL=miniapps.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"miniapps.d.ts","sourceRoot":"","sources":["../../src/modules/miniapps.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAGH,OAAO,EAAC,cAAc,EAAC,MAAM,YAAY,CAAA;AAEzC,iEAAiE;AACjE,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,WAAW,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC,8EAA8E;IAC9E,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACtC;;;OAGG;IACH,SAAS,EAAE,YAAY,GAAG,WAAW,CAAA;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,OAAO,CAAA;IACrB,eAAe,EAAE,KAAK,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAC,CAAC,CAAA;IACtD,eAAe,EAAE,KAAK,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAC,CAAC,CAAA;IACtD,QAAQ,EAAE,MAAM,EAAE,CAAA;CACnB;AAED,6DAA6D;AAC7D,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,OAAO,CAAA;IAChB,aAAa,EAAE,oBAAoB,CAAA;IACnC,kFAAkF;IAClF,MAAM,EAAE,OAAO,CAAA;IACf,wFAAwF;IACxF,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,4FAA4F;IAC5F,2BAA2B,CAAC,EAAE,MAAM,CAAA;IACpC,6DAA6D;IAC7D,OAAO,EAAE,iBAAiB,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC,2EAA2E;IAC3E,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,yFAAyF;AACzF,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,oEAAoE;IACpE,YAAY,EAAE,MAAM,CAAA;IACpB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,mEAAmE;IACnE,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,mEAAmE;IACnE,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,sEAAsE;IACtE,oBAAoB,CAAC,EAAE,0BAA0B,EAAE,CAAA;IACnD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,gBAAgB,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,kCAAkC;IACjD,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,oBAAoB,CAAC,EAAE,0BAA0B,EAAE,CAAA;CACpD;AAED,MAAM,MAAM,2BAA2B,GACnC;IAAC,UAAU,EAAE,IAAI,CAAA;CAAC,GAClB;IAAC,UAAU,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,UAAU,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAC,CAAA;AAE7E,MAAM,MAAM,mBAAmB,GAAG,aAAa,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,GAAG,UAAU,CAAA;AAExG,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,mBAAmB,CAAA;CAC3B;AAED,qBAAa,cAAc;IAGb,OAAO,CAAC,QAAQ,CAAC,OAAO;IAFpC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAwD;gBAE5D,OAAO,EAAE,cAAc;IAEpD;;;;OAIG;IACG,IAAI,CAAC,IAAI,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAQ9D;;;;;;OAMG;IACG,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO/C,sEAAsE;IAChE,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ9C,yCAAyC;IACnC,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO9C;;;;OAIG;IACG,OAAO,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAa5E,uGAAuG;IACjG,yBAAyB,CAAC,OAAO,EAAE,kCAAkC,GAAG,OAAO,CAAC,2BAA2B,CAAC;IASlH,iFAAiF;IACjF,iBAAiB,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,sBAAsB,KAAK,IAAI,GAAG,MAAM,IAAI;IAKlF,gBAAgB;IAChB,uBAAuB,CAAC,QAAQ,EAAE,sBAAsB,GAAG,IAAI;IAI/D,qEAAqE;IAC/D,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAMpD"}
1
+ {"version":3,"file":"miniapps.d.ts","sourceRoot":"","sources":["../../src/modules/miniapps.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,OAAO,EAAC,cAAc,EAAC,MAAM,YAAY,CAAA;AAEzC,iEAAiE;AACjE,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,WAAW,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC,8EAA8E;IAC9E,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACtC;;;OAGG;IACH,SAAS,EAAE,YAAY,GAAG,WAAW,CAAA;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,OAAO,CAAA;IACrB,eAAe,EAAE,KAAK,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAC,CAAC,CAAA;IACtD,eAAe,EAAE,KAAK,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAC,CAAC,CAAA;IACtD,QAAQ,EAAE,MAAM,EAAE,CAAA;CACnB;AAED,6DAA6D;AAC7D,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,OAAO,CAAA;IAChB,aAAa,EAAE,oBAAoB,CAAA;IACnC,kFAAkF;IAClF,MAAM,EAAE,OAAO,CAAA;IACf,6DAA6D;IAC7D,OAAO,EAAE,iBAAiB,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC,2EAA2E;IAC3E,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,4BAA4B;AAC5B,MAAM,WAAW,qBAAqB;IACpC,2EAA2E;IAC3E,GAAG,EAAE,MAAM,CAAA;IACX;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,MAAM,EAAE,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAA;IAC3C,WAAW,EAAE,MAAM,CAAA;IACnB,qEAAqE;IACrE,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,2BAA2B,GACnC,eAAe,GACf,iBAAiB,GACjB,UAAU,GACV,iBAAiB,GACjB,eAAe,GACf,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,WAAW,GACX,mBAAmB,CAAA;AAEvB,MAAM,WAAW,kCAAkC;IACjD,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,oBAAoB,CAAC,EAAE,0BAA0B,EAAE,CAAA;CACpD;AAED,MAAM,MAAM,2BAA2B,GACnC;IAAC,UAAU,EAAE,IAAI,CAAA;CAAC,GAClB;IAAC,UAAU,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,UAAU,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAC,CAAA;AAE7E,qBAAa,cAAc;IACb,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,cAAc;IAEpD;;;;OAIG;IACG,IAAI,CAAC,IAAI,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAQ9D;;;;;;OAMG;IACG,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO/C,sEAAsE;IAChE,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ9C,yCAAyC;IACnC,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO9C;;;;;;;OAOG;IACG,OAAO,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAa5E,gHAAgH;IAC1G,yBAAyB,CAAC,OAAO,EAAE,kCAAkC,GAAG,OAAO,CAAC,2BAA2B,CAAC;IASlH;;;OAGG;IACG,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAMpD"}
@@ -7,16 +7,17 @@
7
7
  * layer (invoke / handle) lives on `session.actions`, not here — these are
8
8
  * operations on the app as a whole, not on a declared action.
9
9
  *
10
- * Installation (`install`, `checkInstallCompatibility`, `uninstall`) is
11
- * narrower still: the host accepts it only from a Store miniapp bundled with
12
- * the Mentra App build. The host downloads, verifies, and activates the
13
- * release through its own installer; the Store only selects the release.
10
+ * Installing (`install`, `checkInstallCompatibility`, `uninstall`) is
11
+ * narrower still: only a miniapp on the Mentra App's system list, running the
12
+ * release the Mentra App installed for it, may install miniapps. Development
13
+ * builds, which may use the calls above, may not. The host installs from a
14
+ * miniapp URL through the same installer as every other way in, with no install
15
+ * sheet: the caller asks the person first.
14
16
  */
15
17
  import { MiniappRequestType } from "../protocol";
16
18
  export class MiniappsModule {
17
19
  constructor(session) {
18
20
  this.session = session;
19
- this.progressHandlers = new Set();
20
21
  }
21
22
  /**
22
23
  * List installed miniapps. Compatible-only by default; pass
@@ -59,21 +60,24 @@ export class MiniappsModule {
59
60
  });
60
61
  }
61
62
  /**
62
- * Download, verify, and install a release through the phone host. Accepted
63
- * only from a Store bundled with the Mentra App build; other callers receive
64
- * NOT_PERMITTED.
63
+ * Install the miniapp at a miniapp URL, with no install sheet: ask the person first. The host fetches its
64
+ * `miniapp.json`, checks the package name against the URL's domain, registers the URL with Mentra, checks the
65
+ * phone can run it, and downloads, verifies and installs its bundle.
66
+ *
67
+ * Only a miniapp on the Mentra App's system list may install; any other caller gets NOT_PERMITTED. A failed
68
+ * install rejects with INSTALL_FAILED, whose `reason` is an {@link InstallMiniappFailureReason}.
65
69
  */
66
70
  async install(request) {
67
71
  return this.session.sendRequest({
68
- ...request,
69
72
  type: MiniappRequestType.MINIAPPS_INSTALL,
73
+ url: request.url,
74
+ ...(request.packageName !== undefined ? { packageName: request.packageName } : {}),
70
75
  },
71
- // Downloading, validating, extracting, asking the user and relaunching
72
- // can legitimately outlast the SDK's default request timeout. The request
73
- // still settles on the host response or session disconnect.
76
+ // Fetching, registering, downloading and installing can legitimately outlast the SDK's default request
77
+ // timeout. The request still settles on the host response or session disconnect.
74
78
  { timeoutMs: 0 });
75
79
  }
76
- /** Check host, Mentra Miniapp SDK, and glasses compatibility before offering or applying an update. */
80
+ /** Check a release's Mentra App, SDK and glasses requirements against this phone. System-list miniapps only. */
77
81
  async checkInstallCompatibility(request) {
78
82
  return this.session.sendRequest({
79
83
  type: MiniappRequestType.MINIAPPS_INSTALL_CHECK,
@@ -82,17 +86,10 @@ export class MiniappsModule {
82
86
  hardwareRequirements: request.hardwareRequirements ?? [],
83
87
  });
84
88
  }
85
- /** Subscribe to host-owned install progress. Returns an unsubscribe function. */
86
- onInstallProgress(handler) {
87
- this.progressHandlers.add(handler);
88
- return () => this.progressHandlers.delete(handler);
89
- }
90
- /** @internal */
91
- _deliverInstallProgress(progress) {
92
- for (const handler of this.progressHandlers)
93
- handler(progress);
94
- }
95
- /** Uninstall a package this Store installed. Bundled Stores only. */
89
+ /**
90
+ * Uninstall a miniapp installed from a miniapp URL. A miniapp the Mentra App bundles, one a workspace manages and a
91
+ * development build stay, with NOT_PERMITTED. System-list miniapps only.
92
+ */
96
93
  async uninstall(packageName) {
97
94
  await this.session.sendRequest({
98
95
  type: MiniappRequestType.MINIAPPS_UNINSTALL,
@@ -1 +1 @@
1
- {"version":3,"file":"miniapps.js","sourceRoot":"","sources":["../../src/modules/miniapps.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAC,kBAAkB,EAAC,MAAM,aAAa,CAAA;AA0H9C,MAAM,OAAO,cAAc;IAGzB,YAA6B,OAAuB;QAAvB,YAAO,GAAP,OAAO,CAAgB;QAFnC,qBAAgB,GAAG,IAAI,GAAG,EAA8C,CAAA;IAElC,CAAC;IAExD;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,IAA0B;QACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAgB;YAC3D,IAAI,EAAE,kBAAkB,CAAC,aAAa;YACtC,mBAAmB,EAAE,IAAI,EAAE,mBAAmB,IAAI,KAAK;SACxD,CAAC,CAAA;QACF,OAAO,MAAM,IAAI,EAAE,CAAA;IACrB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CAAC,WAAmB;QAC7B,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;YACnC,IAAI,EAAE,kBAAkB,CAAC,cAAc;YACvC,WAAW;SACZ,CAAC,CAAA;IACJ,CAAC;IAED,sEAAsE;IACtE,KAAK,CAAC,IAAI,CAAC,WAAmB;QAC5B,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;YACnC,IAAI,EAAE,kBAAkB,CAAC,cAAc;YACvC,WAAW;YACX,UAAU,EAAE,IAAI;SACjB,CAAC,CAAA;IACJ,CAAC;IAED,yCAAyC;IACzC,KAAK,CAAC,IAAI,CAAC,WAAmB;QAC5B,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;YACnC,IAAI,EAAE,kBAAkB,CAAC,aAAa;YACtC,WAAW;SACZ,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,OAA8B;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAC7B;YACE,GAAG,OAAO;YACV,IAAI,EAAE,kBAAkB,CAAC,gBAAgB;SAC1C;QACD,uEAAuE;QACvE,0EAA0E;QAC1E,4DAA4D;QAC5D,EAAC,SAAS,EAAE,CAAC,EAAC,CACf,CAAA;IACH,CAAC;IAED,uGAAuG;IACvG,KAAK,CAAC,yBAAyB,CAAC,OAA2C;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAA8B;YAC3D,IAAI,EAAE,kBAAkB,CAAC,sBAAsB;YAC/C,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,SAAS;YACnD,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,SAAS;YAC3C,oBAAoB,EAAE,OAAO,CAAC,oBAAoB,IAAI,EAAE;SACzD,CAAC,CAAA;IACJ,CAAC;IAED,iFAAiF;IACjF,iBAAiB,CAAC,OAAmD;QACnE,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QAClC,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IACpD,CAAC;IAED,gBAAgB;IAChB,uBAAuB,CAAC,QAAgC;QACtD,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,gBAAgB;YAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;IAChE,CAAC;IAED,qEAAqE;IACrE,KAAK,CAAC,SAAS,CAAC,WAAmB;QACjC,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;YACnC,IAAI,EAAE,kBAAkB,CAAC,kBAAkB;YAC3C,WAAW;SACZ,CAAC,CAAA;IACJ,CAAC;CACF"}
1
+ {"version":3,"file":"miniapps.js","sourceRoot":"","sources":["../../src/modules/miniapps.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAC,kBAAkB,EAAC,MAAM,aAAa,CAAA;AAmH9C,MAAM,OAAO,cAAc;IACzB,YAA6B,OAAuB;QAAvB,YAAO,GAAP,OAAO,CAAgB;IAAG,CAAC;IAExD;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,IAA0B;QACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAgB;YAC3D,IAAI,EAAE,kBAAkB,CAAC,aAAa;YACtC,mBAAmB,EAAE,IAAI,EAAE,mBAAmB,IAAI,KAAK;SACxD,CAAC,CAAA;QACF,OAAO,MAAM,IAAI,EAAE,CAAA;IACrB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,CAAC,WAAmB;QAC7B,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;YACnC,IAAI,EAAE,kBAAkB,CAAC,cAAc;YACvC,WAAW;SACZ,CAAC,CAAA;IACJ,CAAC;IAED,sEAAsE;IACtE,KAAK,CAAC,IAAI,CAAC,WAAmB;QAC5B,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;YACnC,IAAI,EAAE,kBAAkB,CAAC,cAAc;YACvC,WAAW;YACX,UAAU,EAAE,IAAI;SACjB,CAAC,CAAA;IACJ,CAAC;IAED,yCAAyC;IACzC,KAAK,CAAC,IAAI,CAAC,WAAmB;QAC5B,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;YACnC,IAAI,EAAE,kBAAkB,CAAC,aAAa;YACtC,WAAW;SACZ,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO,CAAC,OAA8B;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAC7B;YACE,IAAI,EAAE,kBAAkB,CAAC,gBAAgB;YACzC,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,GAAG,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAC,WAAW,EAAE,OAAO,CAAC,WAAW,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACjF;QACD,uGAAuG;QACvG,iFAAiF;QACjF,EAAC,SAAS,EAAE,CAAC,EAAC,CACf,CAAA;IACH,CAAC;IAED,gHAAgH;IAChH,KAAK,CAAC,yBAAyB,CAAC,OAA2C;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAA8B;YAC3D,IAAI,EAAE,kBAAkB,CAAC,sBAAsB;YAC/C,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,SAAS;YACnD,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,SAAS;YAC3C,oBAAoB,EAAE,OAAO,CAAC,oBAAoB,IAAI,EAAE;SACzD,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAS,CAAC,WAAmB;QACjC,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;YACnC,IAAI,EAAE,kBAAkB,CAAC,kBAAkB;YAC3C,WAAW;SACZ,CAAC,CAAA;IACJ,CAAC;CACF"}
@@ -5,13 +5,15 @@
5
5
  * audio chunks, VAD) lives on session.mic — the split is by I/O direction.
6
6
  *
7
7
  * Imperative surface:
8
- * speaker.play({audioUrl}) — play an arbitrary URL via the phone's
8
+ * speaker.play({audioUrl}) — play an http(s) or data: URL, or one of this
9
+ * miniapp's blobs, via the phone's
9
10
  * AudioPlaybackService.
10
- * speaker.speak(text) — send a SPEAK request. Phone streams cloud
11
- * TTS when connected and falls back to local
12
- * offline TTS when cloud is unavailable.
11
+ * speaker.speak(text) — send a SPEAK request. By default the phone
12
+ * streams cloud TTS when connected and falls
13
+ * back to its on-device voice; the
14
+ * `processing` option picks the order.
13
15
  * Resolves when playback completes; rejects
14
- * with a TTS_* error code on cloud failure.
16
+ * with a TTS_* error code on failure.
15
17
  * speaker.createStream(opts) — open a live PCM output stream (16-bit LE).
16
18
  * Returns a SpeakerStreamWriter: write() PCM
17
19
  * chunks as they arrive (e.g. from a WebSocket
@@ -35,7 +37,12 @@
35
37
  */
36
38
  import { MiniappSession } from "../session";
37
39
  import type { UnsubscribeFn } from "./events";
40
+ import { type SpeechProcessing } from "./speechProcessing";
38
41
  export interface PlayAudioOptions {
42
+ /**
43
+ * An http(s) or `data:` URL, or the `file://` uri of one of this miniapp's
44
+ * blobs (`session.blob`). The host refuses any other file or scheme.
45
+ */
39
46
  audioUrl: string;
40
47
  /** Start playback at this offset in milliseconds. Defaults to zero. */
41
48
  startPositionMs?: number;
@@ -53,10 +60,17 @@ export interface SpeakOptions {
53
60
  */
54
61
  enableSanitization?: boolean;
55
62
  /**
56
- * Force this call to use on-device offline TTS, skipping cloud TTS
57
- * entirely — even when cloud is connected. Rejects with `TTS_LOCAL_UNAVAILABLE`
58
- * if the offline model isn't ready instead of falling back to cloud.
63
+ * Where the speech is synthesized. Default `"preferCloud"`.
64
+ *
65
+ * - `"preferCloud"`: cloud TTS while the cloud is connected, otherwise the
66
+ * phone's on-device voice.
67
+ * - `"preferLocal"`: the on-device voice when its model is ready and can say
68
+ * it (an explicit cloud `voice_id` cannot), otherwise cloud TTS.
69
+ * - `"localOnly"`: the on-device voice only; never the cloud. Rejects with
70
+ * `TTS_LOCAL_UNAVAILABLE` when the on-device model isn't ready.
59
71
  */
72
+ processing?: SpeechProcessing;
73
+ /** @deprecated Use `processing: "localOnly"`. Removed in 4.0; ignored when `processing` is set. */
60
74
  forceLocal?: boolean;
61
75
  }
62
76
  export interface SpeakResult {
@@ -69,6 +83,22 @@ export type SpeakerStreamSampleRate = 16000 | 24000 | 48000;
69
83
  export interface SpeakerStreamOptions {
70
84
  /** PCM sample rate in Hz. Default 16000. */
71
85
  sampleRate?: SpeakerStreamSampleRate;
86
+ /**
87
+ * Open the native stream now and keep it idle until the first write, so a
88
+ * later sound only has to write samples. The speaker reports `idle` and other
89
+ * audio is left alone until then. If the audio route changes before the
90
+ * first write (Bluetooth or glasses connect/disconnect, a call, an audio
91
+ * interruption), the phone closes the stream and the next write fails with
92
+ * "not open"; open a fresh stream then.
93
+ */
94
+ prewarm?: boolean;
95
+ /**
96
+ * How much audio (80–500 ms) the phone queues before playback starts, and
97
+ * the cushion against gaps after that. Default 500. A sound shorter than
98
+ * this still plays once you close the stream. Use a small value such as 80
99
+ * for short cues that should start immediately.
100
+ */
101
+ jitterMs?: number;
72
102
  /** Channel count. v1 is mono only. Default 1. */
73
103
  channels?: 1;
74
104
  /** Playback volume 0..1. Default 1. */
@@ -142,8 +172,9 @@ export declare class SpeakerModule {
142
172
  /** Play a URL. Resolves when playback completes on the phone. */
143
173
  play(options: PlayAudioOptions): Promise<void>;
144
174
  /**
145
- * Speak text through the phone. The host streams cloud TTS when connected,
146
- * then falls back to local offline TTS.
175
+ * Speak text through the phone, in the cloud or on-device as
176
+ * `options.processing` says (default: cloud TTS when connected, then the
177
+ * on-device voice).
147
178
  *
148
179
  * Rejects with a MiniappRequestError containing a `code` field on cloud-side
149
180
  * TTS failures: `TTS_TEXT_TOO_LONG`, `TTS_INVALID_VOICE`, `TTS_UPSTREAM_ERROR`.
@@ -1 +1 @@
1
- {"version":3,"file":"speaker.d.ts","sourceRoot":"","sources":["../../src/modules/speaker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AAGH,OAAO,EAAC,cAAc,EAAC,MAAM,YAAY,CAAA;AAEzC,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,UAAU,CAAA;AAE3C,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,uEAAuE;IACvE,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACxC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,qEAAqE;IACrE,SAAS,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAA;AAI/E,oDAAoD;AACpD,MAAM,MAAM,uBAAuB,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAA;AAE3D,MAAM,WAAW,oBAAoB;IACnC,4CAA4C;IAC5C,UAAU,CAAC,EAAE,uBAAuB,CAAA;IACpC,iDAAiD;IACjD,QAAQ,CAAC,EAAE,CAAC,CAAA;IACZ,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,wEAAwE;IACxE,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC,iEAAiE;IACjE,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,8EAA8E;AAC9E,eAAO,MAAM,yBAAyB,QAAa,CAAA;AAKnD;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,OAAO,CAAA;AAElD;;;;;;;GAOG;AACH,qBAAa,mBAAmB;IAIlB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAAkB,QAAQ,CAAC,QAAQ,EAAE,MAAM;IAH/E,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,UAAU,CAAmC;gBAExB,OAAO,EAAE,cAAc,EAAW,QAAQ,EAAE,MAAM;IAE/E;;;;;OAKG;IACG,KAAK,CAAC,KAAK,EAAE,UAAU,GAAG,WAAW,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAc/E,sFAAsF;IAChF,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAgBjE,+EAA+E;IACzE,KAAK,IAAI,OAAO,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAC,CAAC;IAa7C,gEAAgE;IAC1D,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAS5B,OAAO,CAAC,UAAU;YAIJ,IAAI;IASlB,4EAA4E;IAC5E,OAAO,CAAC,YAAY;CAQrB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,YAAY,CAAA;IACnB,2EAA2E;IAC3E,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,4EAA4E;IAC5E,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,qBAAa,aAAa;IAIZ,OAAO,CAAC,QAAQ,CAAC,OAAO;IAHpC,OAAO,CAAC,MAAM,CAAuB;IACrC,OAAO,CAAC,UAAU,CAAqC;gBAE1B,OAAO,EAAE,cAAc;IAEpD,sCAAsC;IACtC,IAAI,KAAK,IAAI,YAAY,CAExB;IAED,oCAAoC;IACpC,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED,iEAAiE;IAC3D,IAAI,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBpD;;;;;;OAMG;IACG,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IACjE,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IAiC9E;;;;;;;;;OASG;IACG,YAAY,CAAC,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAiBpF,wDAAwD;IACxD,IAAI,IAAI,IAAI;IAIZ;;;;OAIG;IACH,aAAa,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,GAAG,aAAa;IAIzE,+EAA+E;IAC/E,WAAW,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAS3C,6BAA6B;IAC7B,aAAa,IAAI,iBAAiB;CAGnC"}
1
+ {"version":3,"file":"speaker.d.ts","sourceRoot":"","sources":["../../src/modules/speaker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAGH,OAAO,EAAC,cAAc,EAAC,MAAM,YAAY,CAAA;AAEzC,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,UAAU,CAAA;AAC3C,OAAO,EAA0B,KAAK,gBAAgB,EAAC,MAAM,oBAAoB,CAAA;AAEjF,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB,uEAAuE;IACvE,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACxC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAA;IAC7B,mGAAmG;IACnG,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,qEAAqE;IACrE,SAAS,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAA;AAI/E,oDAAoD;AACpD,MAAM,MAAM,uBAAuB,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAA;AAE3D,MAAM,WAAW,oBAAoB;IACnC,4CAA4C;IAC5C,UAAU,CAAC,EAAE,uBAAuB,CAAA;IACpC;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,iDAAiD;IACjD,QAAQ,CAAC,EAAE,CAAC,CAAA;IACZ,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,wEAAwE;IACxE,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC,iEAAiE;IACjE,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,8EAA8E;AAC9E,eAAO,MAAM,yBAAyB,QAAa,CAAA;AAKnD;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,OAAO,CAAA;AAElD;;;;;;;GAOG;AACH,qBAAa,mBAAmB;IAK5B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM;IAL3B,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,UAAU,CAAmC;gBAGlC,OAAO,EAAE,cAAc,EAC/B,QAAQ,EAAE,MAAM;IAG3B;;;;;OAKG;IACG,KAAK,CAAC,KAAK,EAAE,UAAU,GAAG,WAAW,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAc/E,sFAAsF;IAChF,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAgBjE,+EAA+E;IACzE,KAAK,IAAI,OAAO,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAC,CAAC;IAa7C,gEAAgE;IAC1D,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAS5B,OAAO,CAAC,UAAU;YAIJ,IAAI;IASlB,4EAA4E;IAC5E,OAAO,CAAC,YAAY;CAQrB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,YAAY,CAAA;IACnB,2EAA2E;IAC3E,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,4EAA4E;IAC5E,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,qBAAa,aAAa;IAIZ,OAAO,CAAC,QAAQ,CAAC,OAAO;IAHpC,OAAO,CAAC,MAAM,CAAuB;IACrC,OAAO,CAAC,UAAU,CAAqC;gBAE1B,OAAO,EAAE,cAAc;IAEpD,sCAAsC;IACtC,IAAI,KAAK,IAAI,YAAY,CAExB;IAED,oCAAoC;IACpC,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED,iEAAiE;IAC3D,IAAI,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBpD;;;;;;;OAOG;IACG,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IACjE,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IAoC9E;;;;;;;;;OASG;IACG,YAAY,CAAC,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAwBpF,wDAAwD;IACxD,IAAI,IAAI,IAAI;IAIZ;;;;OAIG;IACH,aAAa,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,GAAG,aAAa;IAIzE,+EAA+E;IAC/E,WAAW,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAS3C,6BAA6B;IAC7B,aAAa,IAAI,iBAAiB;CAGnC"}
@@ -5,13 +5,15 @@
5
5
  * audio chunks, VAD) lives on session.mic — the split is by I/O direction.
6
6
  *
7
7
  * Imperative surface:
8
- * speaker.play({audioUrl}) — play an arbitrary URL via the phone's
8
+ * speaker.play({audioUrl}) — play an http(s) or data: URL, or one of this
9
+ * miniapp's blobs, via the phone's
9
10
  * AudioPlaybackService.
10
- * speaker.speak(text) — send a SPEAK request. Phone streams cloud
11
- * TTS when connected and falls back to local
12
- * offline TTS when cloud is unavailable.
11
+ * speaker.speak(text) — send a SPEAK request. By default the phone
12
+ * streams cloud TTS when connected and falls
13
+ * back to its on-device voice; the
14
+ * `processing` option picks the order.
13
15
  * Resolves when playback completes; rejects
14
- * with a TTS_* error code on cloud failure.
16
+ * with a TTS_* error code on failure.
15
17
  * speaker.createStream(opts) — open a live PCM output stream (16-bit LE).
16
18
  * Returns a SpeakerStreamWriter: write() PCM
17
19
  * chunks as they arrive (e.g. from a WebSocket
@@ -35,6 +37,7 @@
35
37
  */
36
38
  import { MiniappErrorCode, MiniappRequestType } from "../protocol";
37
39
  import { bytesToBase64, toUint8Array } from "./base64";
40
+ import { resolveSpeechProcessing } from "./speechProcessing";
38
41
  /** Raw bytes per bridge write. PCM chunks are small; keep messages snappy. */
39
42
  export const SPEAKER_WRITE_CHUNK_BYTES = 256 * 1024;
40
43
  // Every non-final base64 slice must decode to complete 16-bit samples. Six
@@ -176,6 +179,7 @@ export class SpeakerModule {
176
179
  if ((Array.isArray(normalized) && normalized.length === 0) || normalized === "") {
177
180
  throw { code: MiniappErrorCode.INTERNAL, message: "speak requires at least one non-empty sentence" };
178
181
  }
182
+ const processing = resolveSpeechProcessing(options, "speaker.speak(options)");
179
183
  try {
180
184
  // Like play(): resolves only when TTS playback completes, so opt out of the
181
185
  // default request timeout (long text can outlast it). Settled by the host
@@ -188,7 +192,9 @@ export class SpeakerModule {
188
192
  volume: options.volume,
189
193
  stopOtherAudio: options.stopOtherAudio ?? false,
190
194
  enableSanitization: options.enableSanitization ?? true,
191
- forceLocal: options.forceLocal ?? false,
195
+ processing,
196
+ // Hosts before `processing` (Mentra App 3.4.0) read only this flag.
197
+ forceLocal: processing === "localOnly",
192
198
  }, { timeoutMs: 0 });
193
199
  return result ?? { completed: true };
194
200
  }
@@ -215,9 +221,14 @@ export class SpeakerModule {
215
221
  (!Number.isFinite(options.volume) || options.volume < 0 || options.volume > 1)) {
216
222
  throw new RangeError("speaker stream volume must be between 0 and 1");
217
223
  }
224
+ if (options.jitterMs !== undefined &&
225
+ (!Number.isFinite(options.jitterMs) || options.jitterMs < 80 || options.jitterMs > 500))
226
+ throw new RangeError("speaker stream jitterMs must be between 80 and 500");
218
227
  const res = await this.session.sendRequest({
219
228
  type: MiniappRequestType.SPEAKER_STREAM_OPEN,
220
229
  sampleRate: options.sampleRate ?? 16000,
230
+ ...(options.jitterMs === undefined ? {} : { jitterMs: options.jitterMs }),
231
+ ...(options.prewarm === undefined ? {} : { prewarm: options.prewarm }),
221
232
  channels: options.channels ?? 1,
222
233
  volume: options.volume,
223
234
  stopOtherAudio: options.stopOtherAudio ?? true,
@@ -1 +1 @@
1
- {"version":3,"file":"speaker.js","sourceRoot":"","sources":["../../src/modules/speaker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AAEH,OAAO,EAAC,gBAAgB,EAAE,kBAAkB,EAAC,MAAM,aAAa,CAAA;AAEhE,OAAO,EAAC,aAAa,EAAE,YAAY,EAAC,MAAM,UAAU,CAAA;AAyDpD,8EAA8E;AAC9E,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAG,GAAG,IAAI,CAAA;AACnD,2EAA2E;AAC3E,+EAA+E;AAC/E,MAAM,uBAAuB,GAAG,IAAI,CAAC,KAAK,CAAC,yBAAyB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;AAE7E;;;;GAIG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,IAAI,CAAA;AAElD;;;;;;;GAOG;AACH,MAAM,OAAO,mBAAmB;IAI9B,YAA6B,OAAuB,EAAW,QAAgB;QAAlD,YAAO,GAAP,OAAO,CAAgB;QAAW,aAAQ,GAAR,QAAQ,CAAQ;QAHvE,YAAO,GAAG,KAAK,CAAA;QACf,eAAU,GAAkB,OAAO,CAAC,OAAO,EAAE,CAAA;IAE6B,CAAC;IAEnF;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAC,KAA+B;QACzC,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;QACjC,IAAI,KAAK,CAAC,UAAU,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QACxE,IAAI,KAAK,CAAC,UAAU,GAAG,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;QACjG,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YAClC,IAAI,IAAI,GAA6B,EAAC,UAAU,EAAE,CAAC,EAAC,CAAA;YACpD,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,CAAC,MAAM,EAAE,GAAG,IAAI,yBAAyB,EAAE,CAAC;gBACvE,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,GAAG,yBAAyB,CAAC,CAAC,CAAC,CAAA;YAC7F,CAAC;YACD,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,sFAAsF;IACtF,KAAK,CAAC,WAAW,CAAC,GAAW;QAC3B,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;QACxG,MAAM,OAAO,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAClE,MAAM,YAAY,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,OAAO,CAAA;QACnD,IAAI,YAAY,GAAG,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;QAC9F,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YAClC,IAAI,IAAI,GAA6B,EAAC,UAAU,EAAE,CAAC,EAAC,CAAA;YACpD,mEAAmE;YACnE,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,MAAM,EAAE,GAAG,IAAI,uBAAuB,EAAE,CAAC;gBACnE,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,uBAAuB,CAAC,CAAC,CAAA;YACvE,CAAC;YACD,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,+EAA+E;IAC/E,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,MAAM,IAAI,CAAC,UAAU,CAAA;QACrB,wEAAwE;QACxE,0CAA0C;QAC1C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CACxC,EAAC,IAAI,EAAE,kBAAkB,CAAC,oBAAoB,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAC,EACxE,EAAC,SAAS,EAAE,CAAC,EAAC,CACf,CAAA;QACD,OAAO,GAAG,IAAI,EAAE,CAAA;IAClB,CAAC;IAED,gEAAgE;IAChE,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO;YAAE,OAAM;QACxB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;YACnC,IAAI,EAAE,kBAAkB,CAAC,oBAAoB;YAC7C,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC,CAAA;IACJ,CAAC;IAEO,UAAU;QAChB,IAAI,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;IACpF,CAAC;IAEO,KAAK,CAAC,IAAI,CAAC,MAAc;QAC/B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAkC;YAC1E,IAAI,EAAE,kBAAkB,CAAC,oBAAoB;YAC7C,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,MAAM;SACP,CAAC,CAAA;QACF,OAAO,GAAG,IAAI,EAAC,UAAU,EAAE,CAAC,EAAC,CAAA;IAC/B,CAAC;IAED,4EAA4E;IACpE,YAAY,CAAI,SAA2B;QACjD,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAC9C,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,IAAI,CAC3B,GAAG,EAAE,CAAC,SAAS,EACf,GAAG,EAAE,CAAC,SAAS,CAChB,CAAA;QACD,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAWD,MAAM,OAAO,aAAa;IAIxB,YAA6B,OAAuB;QAAvB,YAAO,GAAP,OAAO,CAAgB;QAH5C,WAAM,GAAiB,MAAM,CAAA;QAC7B,eAAU,GAAsB,EAAC,KAAK,EAAE,MAAM,EAAC,CAAA;IAEA,CAAC;IAExD,sCAAsC;IACtC,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAED,oCAAoC;IACpC,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,CAAA;IAClC,CAAC;IAED,iEAAiE;IACjE,KAAK,CAAC,IAAI,CAAC,OAAyB;QAClC,IACE,OAAO,CAAC,eAAe,KAAK,SAAS;YACrC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,OAAO,CAAC,eAAe,GAAG,CAAC,CAAC,EAC1E,CAAC;YACD,MAAM,IAAI,UAAU,CAAC,uDAAuD,CAAC,CAAA;QAC/E,CAAC;QACD,0EAA0E;QAC1E,6EAA6E;QAC7E,8EAA8E;QAC9E,+EAA+E;QAC/E,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAC5B;YACE,IAAI,EAAE,kBAAkB,CAAC,UAAU;YACnC,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,GAAG,CAAC,OAAO,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,EAAC,eAAe,EAAE,OAAO,CAAC,eAAe,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5F,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,KAAK;SAChD,EACD,EAAC,SAAS,EAAE,CAAC,EAAC,CACf,CAAA;IACH,CAAC;IAWD,KAAK,CAAC,KAAK,CAAC,IAAuB,EAAE,UAAwB,EAAE;QAC7D,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAA;QAC9G,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;YAChF,MAAM,EAAC,IAAI,EAAE,gBAAgB,CAAC,QAAQ,EAAE,OAAO,EAAE,gDAAgD,EAAC,CAAA;QACpG,CAAC;QACD,IAAI,CAAC;YACH,4EAA4E;YAC5E,0EAA0E;YAC1E,mCAAmC;YACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAC3C;gBACE,IAAI,EAAE,kBAAkB,CAAC,KAAK;gBAC9B,IAAI,EAAE,UAAU;gBAChB,QAAQ,EAAE,OAAO,CAAC,QAAQ;gBAC1B,cAAc,EAAE,OAAO,CAAC,cAAc;gBACtC,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,KAAK;gBAC/C,kBAAkB,EAAE,OAAO,CAAC,kBAAkB,IAAI,IAAI;gBACtD,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,KAAK;aACxC,EACD,EAAC,SAAS,EAAE,CAAC,EAAC,CACf,CAAA;YACD,OAAO,MAAM,IAAI,EAAC,SAAS,EAAE,IAAI,EAAC,CAAA;QACpC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,iFAAiF;YACjF,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC;gBACpD,MAAM,GAAG,CAAA;YACX,CAAC;YACD,MAAM,EAAC,IAAI,EAAE,gBAAgB,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,EAAC,CAAA;QAC/D,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,YAAY,CAAC,UAAgC,EAAE;QACnD,IACE,OAAO,CAAC,MAAM,KAAK,SAAS;YAC5B,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,EAC9E,CAAC;YACD,MAAM,IAAI,UAAU,CAAC,+CAA+C,CAAC,CAAA;QACvE,CAAC;QACD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAqB;YAC7D,IAAI,EAAE,kBAAkB,CAAC,mBAAmB;YAC5C,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,KAAK;YACvC,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,CAAC;YAC/B,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,IAAI;SAC/C,CAAC,CAAA;QACF,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAA;IAC5D,CAAC;IAED,wDAAwD;IACxD,IAAI;QACF,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAC,IAAI,EAAE,kBAAkB,CAAC,UAAU,EAAC,CAAC,CAAA;IACjE,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,OAA2C;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;IACjD,CAAC;IAED,+EAA+E;IAC/E,WAAW,CAAC,KAAwB;QAClC,sEAAsE;QACtE,sEAAsE;QACtE,uDAAuD;QACvD,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,KAAK,OAAO;YAAE,OAAM;QAClE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAA;QACzB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;IACzB,CAAC;IAED,6BAA6B;IAC7B,aAAa;QACX,OAAO,EAAC,GAAG,IAAI,CAAC,UAAU,EAAC,CAAA;IAC7B,CAAC;CACF"}
1
+ {"version":3,"file":"speaker.js","sourceRoot":"","sources":["../../src/modules/speaker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH,OAAO,EAAC,gBAAgB,EAAE,kBAAkB,EAAC,MAAM,aAAa,CAAA;AAEhE,OAAO,EAAC,aAAa,EAAE,YAAY,EAAC,MAAM,UAAU,CAAA;AAEpD,OAAO,EAAC,uBAAuB,EAAwB,MAAM,oBAAoB,CAAA;AAmFjF,8EAA8E;AAC9E,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAG,GAAG,IAAI,CAAA;AACnD,2EAA2E;AAC3E,+EAA+E;AAC/E,MAAM,uBAAuB,GAAG,IAAI,CAAC,KAAK,CAAC,yBAAyB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;AAE7E;;;;GAIG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,IAAI,CAAA;AAElD;;;;;;;GAOG;AACH,MAAM,OAAO,mBAAmB;IAI9B,YACmB,OAAuB,EAC/B,QAAgB;QADR,YAAO,GAAP,OAAO,CAAgB;QAC/B,aAAQ,GAAR,QAAQ,CAAQ;QALnB,YAAO,GAAG,KAAK,CAAA;QACf,eAAU,GAAkB,OAAO,CAAC,OAAO,EAAE,CAAA;IAKlD,CAAC;IAEJ;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAC,KAA+B;QACzC,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;QACjC,IAAI,KAAK,CAAC,UAAU,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QACxE,IAAI,KAAK,CAAC,UAAU,GAAG,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;QACjG,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YAClC,IAAI,IAAI,GAA6B,EAAC,UAAU,EAAE,CAAC,EAAC,CAAA;YACpD,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,CAAC,MAAM,EAAE,GAAG,IAAI,yBAAyB,EAAE,CAAC;gBACvE,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,GAAG,yBAAyB,CAAC,CAAC,CAAC,CAAA;YAC7F,CAAC;YACD,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,sFAAsF;IACtF,KAAK,CAAC,WAAW,CAAC,GAAW;QAC3B,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;QACxG,MAAM,OAAO,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAClE,MAAM,YAAY,GAAG,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,OAAO,CAAA;QACnD,IAAI,YAAY,GAAG,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;QAC9F,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YAClC,IAAI,IAAI,GAA6B,EAAC,UAAU,EAAE,CAAC,EAAC,CAAA;YACpD,mEAAmE;YACnE,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,MAAM,EAAE,GAAG,IAAI,uBAAuB,EAAE,CAAC;gBACnE,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,GAAG,uBAAuB,CAAC,CAAC,CAAA;YACvE,CAAC;YACD,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,+EAA+E;IAC/E,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,MAAM,IAAI,CAAC,UAAU,CAAA;QACrB,wEAAwE;QACxE,0CAA0C;QAC1C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CACxC,EAAC,IAAI,EAAE,kBAAkB,CAAC,oBAAoB,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAC,EACxE,EAAC,SAAS,EAAE,CAAC,EAAC,CACf,CAAA;QACD,OAAO,GAAG,IAAI,EAAE,CAAA;IAClB,CAAC;IAED,gEAAgE;IAChE,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,OAAO;YAAE,OAAM;QACxB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAO;YACnC,IAAI,EAAE,kBAAkB,CAAC,oBAAoB;YAC7C,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC,CAAA;IACJ,CAAC;IAEO,UAAU;QAChB,IAAI,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;IACpF,CAAC;IAEO,KAAK,CAAC,IAAI,CAAC,MAAc;QAC/B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAkC;YAC1E,IAAI,EAAE,kBAAkB,CAAC,oBAAoB;YAC7C,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,MAAM;SACP,CAAC,CAAA;QACF,OAAO,GAAG,IAAI,EAAC,UAAU,EAAE,CAAC,EAAC,CAAA;IAC/B,CAAC;IAED,4EAA4E;IACpE,YAAY,CAAI,SAA2B;QACjD,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAC9C,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,IAAI,CAC3B,GAAG,EAAE,CAAC,SAAS,EACf,GAAG,EAAE,CAAC,SAAS,CAChB,CAAA;QACD,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAWD,MAAM,OAAO,aAAa;IAIxB,YAA6B,OAAuB;QAAvB,YAAO,GAAP,OAAO,CAAgB;QAH5C,WAAM,GAAiB,MAAM,CAAA;QAC7B,eAAU,GAAsB,EAAC,KAAK,EAAE,MAAM,EAAC,CAAA;IAEA,CAAC;IAExD,sCAAsC;IACtC,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAED,oCAAoC;IACpC,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,CAAA;IAClC,CAAC;IAED,iEAAiE;IACjE,KAAK,CAAC,IAAI,CAAC,OAAyB;QAClC,IACE,OAAO,CAAC,eAAe,KAAK,SAAS;YACrC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,OAAO,CAAC,eAAe,GAAG,CAAC,CAAC,EAC1E,CAAC;YACD,MAAM,IAAI,UAAU,CAAC,uDAAuD,CAAC,CAAA;QAC/E,CAAC;QACD,0EAA0E;QAC1E,6EAA6E;QAC7E,8EAA8E;QAC9E,+EAA+E;QAC/E,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAC5B;YACE,IAAI,EAAE,kBAAkB,CAAC,UAAU;YACnC,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,GAAG,CAAC,OAAO,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,EAAC,eAAe,EAAE,OAAO,CAAC,eAAe,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5F,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,KAAK;SAChD,EACD,EAAC,SAAS,EAAE,CAAC,EAAC,CACf,CAAA;IACH,CAAC;IAYD,KAAK,CAAC,KAAK,CAAC,IAAuB,EAAE,UAAwB,EAAE;QAC7D,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAA;QAC9G,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;YAChF,MAAM,EAAC,IAAI,EAAE,gBAAgB,CAAC,QAAQ,EAAE,OAAO,EAAE,gDAAgD,EAAC,CAAA;QACpG,CAAC;QACD,MAAM,UAAU,GAAG,uBAAuB,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAA;QAC7E,IAAI,CAAC;YACH,4EAA4E;YAC5E,0EAA0E;YAC1E,mCAAmC;YACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAC3C;gBACE,IAAI,EAAE,kBAAkB,CAAC,KAAK;gBAC9B,IAAI,EAAE,UAAU;gBAChB,QAAQ,EAAE,OAAO,CAAC,QAAQ;gBAC1B,cAAc,EAAE,OAAO,CAAC,cAAc;gBACtC,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,KAAK;gBAC/C,kBAAkB,EAAE,OAAO,CAAC,kBAAkB,IAAI,IAAI;gBACtD,UAAU;gBACV,oEAAoE;gBACpE,UAAU,EAAE,UAAU,KAAK,WAAW;aACvC,EACD,EAAC,SAAS,EAAE,CAAC,EAAC,CACf,CAAA;YACD,OAAO,MAAM,IAAI,EAAC,SAAS,EAAE,IAAI,EAAC,CAAA;QACpC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,iFAAiF;YACjF,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC;gBACpD,MAAM,GAAG,CAAA;YACX,CAAC;YACD,MAAM,EAAC,IAAI,EAAE,gBAAgB,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,EAAC,CAAA;QAC/D,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,YAAY,CAAC,UAAgC,EAAE;QACnD,IACE,OAAO,CAAC,MAAM,KAAK,SAAS;YAC5B,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,EAC9E,CAAC;YACD,MAAM,IAAI,UAAU,CAAC,+CAA+C,CAAC,CAAA;QACvE,CAAC;QACD,IACE,OAAO,CAAC,QAAQ,KAAK,SAAS;YAC9B,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC,QAAQ,GAAG,EAAE,IAAI,OAAO,CAAC,QAAQ,GAAG,GAAG,CAAC;YAEvF,MAAM,IAAI,UAAU,CAAC,oDAAoD,CAAC,CAAA;QAC5E,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAqB;YAC7D,IAAI,EAAE,kBAAkB,CAAC,mBAAmB;YAC5C,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,KAAK;YACvC,GAAG,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAC,CAAC;YACvE,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,OAAO,EAAE,OAAO,CAAC,OAAO,EAAC,CAAC;YACpE,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,CAAC;YAC/B,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,IAAI;SAC/C,CAAC,CAAA;QACF,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAA;IAC5D,CAAC;IAED,wDAAwD;IACxD,IAAI;QACF,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAC,IAAI,EAAE,kBAAkB,CAAC,UAAU,EAAC,CAAC,CAAA;IACjE,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,OAA2C;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;IACjD,CAAC;IAED,+EAA+E;IAC/E,WAAW,CAAC,KAAwB;QAClC,sEAAsE;QACtE,sEAAsE;QACtE,uDAAuD;QACvD,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,KAAK,OAAO;YAAE,OAAM;QAClE,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAA;QACzB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;IACzB,CAAC;IAED,6BAA6B;IAC7B,aAAa;QACX,OAAO,EAAC,GAAG,IAAI,CAAC,UAAU,EAAC,CAAA;IAC7B,CAAC;CACF"}
@@ -0,0 +1,29 @@
1
+ /**
2
+ * @fileoverview Where speech is processed: on the phone or in the cloud.
3
+ *
4
+ * Transcription listeners (`session.transcription.on` / `forLanguage`) and
5
+ * speech requests (`session.speaker.speak`) take the same `processing` option.
6
+ */
7
+ /**
8
+ * Where speech is processed.
9
+ *
10
+ * - `"preferCloud"` (default): the cloud; the phone's on-device models only
11
+ * while the cloud is unreachable.
12
+ * - `"preferLocal"`: on-device when a model for the language is ready,
13
+ * otherwise the cloud.
14
+ * - `"localOnly"`: on-device only; never the cloud.
15
+ */
16
+ export type SpeechProcessing = "preferCloud" | "preferLocal" | "localOnly";
17
+ /** The `processing` option, with the deprecated `forceLocal` it replaces. */
18
+ export interface SpeechProcessingOptions {
19
+ processing?: SpeechProcessing;
20
+ /** @deprecated Use `processing: "localOnly"`. Removed in 4.0. */
21
+ forceLocal?: boolean;
22
+ }
23
+ /**
24
+ * @internal The processing an options object asks for. `processing` wins;
25
+ * without it, the deprecated `forceLocal: true` means `"localOnly"`.
26
+ * Throws `MiniappValidationError` for an unknown `processing` value.
27
+ */
28
+ export declare function resolveSpeechProcessing(options: SpeechProcessingOptions, where: string): SpeechProcessing;
29
+ //# sourceMappingURL=speechProcessing.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"speechProcessing.d.ts","sourceRoot":"","sources":["../../src/modules/speechProcessing.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG,aAAa,GAAG,WAAW,CAAA;AAI1E,6EAA6E;AAC7E,MAAM,WAAW,uBAAuB;IACtC,UAAU,CAAC,EAAE,gBAAgB,CAAA;IAC7B,iEAAiE;IACjE,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,uBAAuB,EAAE,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAOzG"}
@@ -0,0 +1,22 @@
1
+ /**
2
+ * @fileoverview Where speech is processed: on the phone or in the cloud.
3
+ *
4
+ * Transcription listeners (`session.transcription.on` / `forLanguage`) and
5
+ * speech requests (`session.speaker.speak`) take the same `processing` option.
6
+ */
7
+ import { MiniappValidationError } from "./languages";
8
+ const SPEECH_PROCESSING = ["preferCloud", "preferLocal", "localOnly"];
9
+ /**
10
+ * @internal The processing an options object asks for. `processing` wins;
11
+ * without it, the deprecated `forceLocal: true` means `"localOnly"`.
12
+ * Throws `MiniappValidationError` for an unknown `processing` value.
13
+ */
14
+ export function resolveSpeechProcessing(options, where) {
15
+ const { processing } = options;
16
+ if (processing === undefined)
17
+ return options.forceLocal === true ? "localOnly" : "preferCloud";
18
+ if (SPEECH_PROCESSING.includes(processing))
19
+ return processing;
20
+ throw new MiniappValidationError(`${where}: unknown processing ${JSON.stringify(processing)}. Use ${SPEECH_PROCESSING.map((value) => `"${value}"`).join(", ")}.`);
21
+ }
22
+ //# sourceMappingURL=speechProcessing.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"speechProcessing.js","sourceRoot":"","sources":["../../src/modules/speechProcessing.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,sBAAsB,EAAC,MAAM,aAAa,CAAA;AAalD,MAAM,iBAAiB,GAAgC,CAAC,aAAa,EAAE,aAAa,EAAE,WAAW,CAAC,CAAA;AASlG;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,OAAgC,EAAE,KAAa;IACrF,MAAM,EAAC,UAAU,EAAC,GAAG,OAAO,CAAA;IAC5B,IAAI,UAAU,KAAK,SAAS;QAAE,OAAO,OAAO,CAAC,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAA;IAC9F,IAAI,iBAAiB,CAAC,QAAQ,CAAC,UAAU,CAAC;QAAE,OAAO,UAAU,CAAA;IAC7D,MAAM,IAAI,sBAAsB,CAC9B,GAAG,KAAK,wBAAwB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS,iBAAiB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAChI,CAAA;AACH,CAAC"}
@@ -6,13 +6,17 @@
6
6
  import { MiniappSession } from "../session";
7
7
  export interface ShareOptions {
8
8
  text?: string;
9
+ /**
10
+ * An http(s) link, or the `file://` uri of one of this miniapp's blobs
11
+ * (`session.blob`). The host refuses any other file or scheme.
12
+ */
9
13
  url?: string;
10
14
  title?: string;
11
15
  /** Base64-encoded file data for file sharing. */
12
16
  base64?: string;
13
17
  /** MIME type when sharing base64 data. */
14
18
  mimeType?: string;
15
- /** Filename when sharing base64 data. */
19
+ /** File name when sharing base64 data: one name; path separators become `_`. */
16
20
  filename?: string;
17
21
  }
18
22
  export interface ShareResult {
@@ -20,9 +24,10 @@ export interface ShareResult {
20
24
  cancelled?: boolean;
21
25
  }
22
26
  export interface DownloadOptions {
23
- /** URL to download from, OR base64 data. */
27
+ /** An http: or https: URL to download from, OR base64 data. */
24
28
  url?: string;
25
29
  base64?: string;
30
+ /** One file name; path separators become `_`. */
26
31
  filename?: string;
27
32
  mimeType?: string;
28
33
  }
@@ -48,7 +53,7 @@ export declare class SystemModule {
48
53
  constructor(session: MiniappSession);
49
54
  /** Open the OS share sheet with the given content. */
50
55
  share(options: ShareOptions): Promise<ShareResult>;
51
- /** Open a URL in the system browser. Blocks dangerous schemes (javascript:, file:). */
56
+ /** Open a URL in the system browser. Never opens local files or scripts (file:, content:, javascript:, data:). */
52
57
  openUrl(url: string): void;
53
58
  /** Copy text to the system clipboard. */
54
59
  copyToClipboard(text: string): Promise<void>;