@pitcher/js-api 1.28.0 → 1.29.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.
- package/js-api.esm.js +69 -5
- package/js-api.esm.js.map +1 -1
- package/js-api.umd.min.js +10 -10
- package/js-api.umd.min.js.map +1 -1
- package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +18 -18
- package/lib/apps/canvas-builder/util/canvas.util.d.ts +8 -0
- package/lib/sdk/api/HighLevelApi.d.ts +9 -3
- package/lib/sdk/api/modules/admin/types.admin.d.ts +1 -0
- package/lib/sdk/api/modules/index.d.ts +2 -1
- package/lib/sdk/api/modules/stt.d.ts +65 -0
- package/lib/sdk/api/modules/stt.spec.d.ts +1 -0
- package/lib/sdk/api/modules/tts.d.ts +41 -0
- package/lib/sdk/api/modules/tts.spec.d.ts +1 -0
- package/lib/sdk/interfaces.d.ts +26 -1
- package/lib/sdk/main.d.ts +27 -6
- package/lib/sdk/payload.types.d.ts +180 -0
- package/lib/types/canvases.d.ts +0 -3
- package/lib/types/launchDarkly.types.d.ts +1 -1
- package/lib/types/sfdc.d.ts +15 -0
- package/lib/util/soql.util.d.ts +36 -0
- package/package.json +1 -1
- package/types/openapi/index.d.ts +0 -1
- package/types/openapi/models/PatchedUserRequest.d.ts +1 -2
- package/types/openapi/models/User.d.ts +1 -2
- package/types/openapi/models/UserRequest.d.ts +1 -2
- package/lib/sdk/api/modules/languages.d.ts +0 -8
- package/types/openapi/models/LanguageEnum.d.ts +0 -12
|
@@ -92,7 +92,7 @@ export default function useCanvasTheme(): {
|
|
|
92
92
|
readonly deactivated_at: string | null;
|
|
93
93
|
readonly activated_at: string | null;
|
|
94
94
|
readonly is_active: boolean;
|
|
95
|
-
language?:
|
|
95
|
+
language?: string | undefined;
|
|
96
96
|
readonly connected_services: {
|
|
97
97
|
connection_id: string;
|
|
98
98
|
type: string;
|
|
@@ -121,7 +121,7 @@ export default function useCanvasTheme(): {
|
|
|
121
121
|
readonly deactivated_at: string | null;
|
|
122
122
|
readonly activated_at: string | null;
|
|
123
123
|
readonly is_active: boolean;
|
|
124
|
-
language?:
|
|
124
|
+
language?: string | undefined;
|
|
125
125
|
readonly connected_services: {
|
|
126
126
|
connection_id: string;
|
|
127
127
|
type: string;
|
|
@@ -150,7 +150,7 @@ export default function useCanvasTheme(): {
|
|
|
150
150
|
readonly deactivated_at: string | null;
|
|
151
151
|
readonly activated_at: string | null;
|
|
152
152
|
readonly is_active: boolean;
|
|
153
|
-
language?:
|
|
153
|
+
language?: string | undefined;
|
|
154
154
|
readonly connected_services: {
|
|
155
155
|
connection_id: string;
|
|
156
156
|
type: string;
|
|
@@ -209,7 +209,7 @@ export default function useCanvasTheme(): {
|
|
|
209
209
|
readonly deactivated_at: string | null;
|
|
210
210
|
readonly activated_at: string | null;
|
|
211
211
|
readonly is_active: boolean;
|
|
212
|
-
language?:
|
|
212
|
+
language?: string | undefined;
|
|
213
213
|
readonly connected_services: {
|
|
214
214
|
connection_id: string;
|
|
215
215
|
type: string;
|
|
@@ -238,7 +238,7 @@ export default function useCanvasTheme(): {
|
|
|
238
238
|
readonly deactivated_at: string | null;
|
|
239
239
|
readonly activated_at: string | null;
|
|
240
240
|
readonly is_active: boolean;
|
|
241
|
-
language?:
|
|
241
|
+
language?: string | undefined;
|
|
242
242
|
readonly connected_services: {
|
|
243
243
|
connection_id: string;
|
|
244
244
|
type: string;
|
|
@@ -267,7 +267,7 @@ export default function useCanvasTheme(): {
|
|
|
267
267
|
readonly deactivated_at: string | null;
|
|
268
268
|
readonly activated_at: string | null;
|
|
269
269
|
readonly is_active: boolean;
|
|
270
|
-
language?:
|
|
270
|
+
language?: string | undefined;
|
|
271
271
|
readonly connected_services: {
|
|
272
272
|
connection_id: string;
|
|
273
273
|
type: string;
|
|
@@ -489,7 +489,7 @@ export default function useCanvasTheme(): {
|
|
|
489
489
|
readonly deactivated_at: string | null;
|
|
490
490
|
readonly activated_at: string | null;
|
|
491
491
|
readonly is_active: boolean;
|
|
492
|
-
language?:
|
|
492
|
+
language?: string | undefined;
|
|
493
493
|
readonly connected_services: {
|
|
494
494
|
connection_id: string;
|
|
495
495
|
type: string;
|
|
@@ -518,7 +518,7 @@ export default function useCanvasTheme(): {
|
|
|
518
518
|
readonly deactivated_at: string | null;
|
|
519
519
|
readonly activated_at: string | null;
|
|
520
520
|
readonly is_active: boolean;
|
|
521
|
-
language?:
|
|
521
|
+
language?: string | undefined;
|
|
522
522
|
readonly connected_services: {
|
|
523
523
|
connection_id: string;
|
|
524
524
|
type: string;
|
|
@@ -547,7 +547,7 @@ export default function useCanvasTheme(): {
|
|
|
547
547
|
readonly deactivated_at: string | null;
|
|
548
548
|
readonly activated_at: string | null;
|
|
549
549
|
readonly is_active: boolean;
|
|
550
|
-
language?:
|
|
550
|
+
language?: string | undefined;
|
|
551
551
|
readonly connected_services: {
|
|
552
552
|
connection_id: string;
|
|
553
553
|
type: string;
|
|
@@ -606,7 +606,7 @@ export default function useCanvasTheme(): {
|
|
|
606
606
|
readonly deactivated_at: string | null;
|
|
607
607
|
readonly activated_at: string | null;
|
|
608
608
|
readonly is_active: boolean;
|
|
609
|
-
language?:
|
|
609
|
+
language?: string | undefined;
|
|
610
610
|
readonly connected_services: {
|
|
611
611
|
connection_id: string;
|
|
612
612
|
type: string;
|
|
@@ -635,7 +635,7 @@ export default function useCanvasTheme(): {
|
|
|
635
635
|
readonly deactivated_at: string | null;
|
|
636
636
|
readonly activated_at: string | null;
|
|
637
637
|
readonly is_active: boolean;
|
|
638
|
-
language?:
|
|
638
|
+
language?: string | undefined;
|
|
639
639
|
readonly connected_services: {
|
|
640
640
|
connection_id: string;
|
|
641
641
|
type: string;
|
|
@@ -664,7 +664,7 @@ export default function useCanvasTheme(): {
|
|
|
664
664
|
readonly deactivated_at: string | null;
|
|
665
665
|
readonly activated_at: string | null;
|
|
666
666
|
readonly is_active: boolean;
|
|
667
|
-
language?:
|
|
667
|
+
language?: string | undefined;
|
|
668
668
|
readonly connected_services: {
|
|
669
669
|
connection_id: string;
|
|
670
670
|
type: string;
|
|
@@ -731,7 +731,7 @@ export default function useCanvasTheme(): {
|
|
|
731
731
|
readonly deactivated_at: string | null;
|
|
732
732
|
readonly activated_at: string | null;
|
|
733
733
|
readonly is_active: boolean;
|
|
734
|
-
language?:
|
|
734
|
+
language?: string | undefined;
|
|
735
735
|
readonly connected_services: {
|
|
736
736
|
connection_id: string;
|
|
737
737
|
type: string;
|
|
@@ -760,7 +760,7 @@ export default function useCanvasTheme(): {
|
|
|
760
760
|
readonly deactivated_at: string | null;
|
|
761
761
|
readonly activated_at: string | null;
|
|
762
762
|
readonly is_active: boolean;
|
|
763
|
-
language?:
|
|
763
|
+
language?: string | undefined;
|
|
764
764
|
readonly connected_services: {
|
|
765
765
|
connection_id: string;
|
|
766
766
|
type: string;
|
|
@@ -789,7 +789,7 @@ export default function useCanvasTheme(): {
|
|
|
789
789
|
readonly deactivated_at: string | null;
|
|
790
790
|
readonly activated_at: string | null;
|
|
791
791
|
readonly is_active: boolean;
|
|
792
|
-
language?:
|
|
792
|
+
language?: string | undefined;
|
|
793
793
|
readonly connected_services: {
|
|
794
794
|
connection_id: string;
|
|
795
795
|
type: string;
|
|
@@ -848,7 +848,7 @@ export default function useCanvasTheme(): {
|
|
|
848
848
|
readonly deactivated_at: string | null;
|
|
849
849
|
readonly activated_at: string | null;
|
|
850
850
|
readonly is_active: boolean;
|
|
851
|
-
language?:
|
|
851
|
+
language?: string | undefined;
|
|
852
852
|
readonly connected_services: {
|
|
853
853
|
connection_id: string;
|
|
854
854
|
type: string;
|
|
@@ -877,7 +877,7 @@ export default function useCanvasTheme(): {
|
|
|
877
877
|
readonly deactivated_at: string | null;
|
|
878
878
|
readonly activated_at: string | null;
|
|
879
879
|
readonly is_active: boolean;
|
|
880
|
-
language?:
|
|
880
|
+
language?: string | undefined;
|
|
881
881
|
readonly connected_services: {
|
|
882
882
|
connection_id: string;
|
|
883
883
|
type: string;
|
|
@@ -906,7 +906,7 @@ export default function useCanvasTheme(): {
|
|
|
906
906
|
readonly deactivated_at: string | null;
|
|
907
907
|
readonly activated_at: string | null;
|
|
908
908
|
readonly is_active: boolean;
|
|
909
|
-
language?:
|
|
909
|
+
language?: string | undefined;
|
|
910
910
|
readonly connected_services: {
|
|
911
911
|
connection_id: string;
|
|
912
912
|
type: string;
|
|
@@ -65,5 +65,13 @@ export declare function updateFirstCollectionPlayerWithShareboxItems(canvasConte
|
|
|
65
65
|
export declare function handleThemeAssetComparison(key: string | symbol | number, objValue: any, othValue: any, object: any, other: any, fileProps: string[], isEqual: (obj1: any, obj2: any) => boolean, componentsWithThemeMeta?: Set<string>): boolean | undefined;
|
|
66
66
|
export declare function applyCanvasThemeAssetsToNode(node: ComponentNode): ComponentNode;
|
|
67
67
|
export declare function processCanvasForSectionThemeOverride(canvas: CanvasRetrieve, maintainSectionTheme: boolean): CanvasRetrieve;
|
|
68
|
+
/**
|
|
69
|
+
* Append `?instance_id=` to a core-API path when the id is known (PIT-7587).
|
|
70
|
+
* The canvas metadata PATCH is gated on the instance-scoped `canvas.update`
|
|
71
|
+
* permission, and the proxy doesn't forward `x-instance-id` on these calls, so
|
|
72
|
+
* instance context must travel as a query param (mirrors next-core's
|
|
73
|
+
* header-then-query fallback in `with-permission.ts`).
|
|
74
|
+
*/
|
|
75
|
+
export declare function withInstanceId(path: string, instanceId?: string | null): string;
|
|
68
76
|
export declare function isEmbeddableWithZeroHeight(component: ComponentNode): boolean;
|
|
69
77
|
export {};
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { LowLevelApi } from './LowLevelApi';
|
|
2
2
|
import { PitcherEvent, ApiOptions } from '../interfaces';
|
|
3
|
-
import * as modules from './modules';
|
|
4
3
|
/**
|
|
5
4
|
* Creates a high-level API instance and caches it. Reterns a new instance only if new options are provided.
|
|
6
5
|
*/
|
|
@@ -134,10 +133,9 @@ export declare function createHighLevelApi(options?: ApiOptions): {
|
|
|
134
133
|
openExternalUrl(payload: import('../payload.types').OpenExternalUrlRequestPayload): Promise<void>;
|
|
135
134
|
getEnv(): Promise<import('../interfaces').PitcherEnv>;
|
|
136
135
|
updateMyUser(payload: {
|
|
137
|
-
language?:
|
|
136
|
+
language?: string | undefined;
|
|
138
137
|
}): Promise<import('../../main.lib').User>;
|
|
139
138
|
isOffline(): Promise<boolean>;
|
|
140
|
-
getLanguages(): Promise<modules.Language[]>;
|
|
141
139
|
getCanvases(payload: import('../../main.lib').GetCanvasesParams & {
|
|
142
140
|
filters?: Record<string, any>;
|
|
143
141
|
fields?: string;
|
|
@@ -305,5 +303,13 @@ export declare function createHighLevelApi(options?: ApiOptions): {
|
|
|
305
303
|
canvas_id: import('../../main.lib').CanvasRetrieve["id"];
|
|
306
304
|
theme_id: import('../../main.lib').CanvasThemeRetrieve["id"];
|
|
307
305
|
}>;
|
|
306
|
+
sttStart(payload: import('../payload.types').SttStartPayload): Promise<void>;
|
|
307
|
+
sttAvailability(): Promise<import('../payload.types').SttAvailabilityResult>;
|
|
308
|
+
sttWarmup(): Promise<void>;
|
|
309
|
+
sttStop(payload: import('../payload.types').SttStopPayload): Promise<import('../payload.types').SttStopResult>;
|
|
310
|
+
sttErrorCode(error: unknown): import('../payload.types').SttErrorCode | undefined;
|
|
311
|
+
ttsSpeak(payload: import('../payload.types').TtsSpeakPayload): Promise<import('../payload.types').TtsSpeakResult>;
|
|
312
|
+
ttsStop(): Promise<void>;
|
|
313
|
+
ttsErrorCode(error: unknown): import('../payload.types').TtsErrorCode | undefined;
|
|
308
314
|
API: LowLevelApi;
|
|
309
315
|
};
|
|
@@ -254,6 +254,7 @@ export type AdminEnv = {
|
|
|
254
254
|
mode?: PitcherEnv['mode'];
|
|
255
255
|
pitcher: PitcherEnv['pitcher'];
|
|
256
256
|
launch_darkly?: LaunchDarklyEnv;
|
|
257
|
+
ui_locale?: PitcherEnv['ui_locale'];
|
|
257
258
|
client_type?: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
|
|
258
259
|
crm_shape?: Record<string, any>;
|
|
259
260
|
state?: PitcherEnv['state'];
|
|
@@ -2,7 +2,6 @@ export * from './ai';
|
|
|
2
2
|
export * from './appsDb';
|
|
3
3
|
export * from './open';
|
|
4
4
|
export * from './env';
|
|
5
|
-
export * from './languages';
|
|
6
5
|
export * from './canvas';
|
|
7
6
|
export * from './files';
|
|
8
7
|
export * from './filesRevisions';
|
|
@@ -21,3 +20,5 @@ export * from './feedback';
|
|
|
21
20
|
export * from './webView';
|
|
22
21
|
export * from './share';
|
|
23
22
|
export * from './theme';
|
|
23
|
+
export * from './stt';
|
|
24
|
+
export * from './tts';
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { SttAvailabilityResult, SttErrorCode, SttStartPayload, SttStopPayload, SttStopResult } from '../../payload.types';
|
|
2
|
+
export declare function sttStart(payload: SttStartPayload): Promise<void>;
|
|
3
|
+
/**
|
|
4
|
+
* Check whether dictation can be offered — a side-effect-free capability probe
|
|
5
|
+
* to gate a mic button. Does NOT prompt for the microphone or download a model.
|
|
6
|
+
* Answered by the native bridge on iOS and the Impact host on web.
|
|
7
|
+
*
|
|
8
|
+
* @returns {Promise<SttAvailabilityResult>} `{ available, engine, reason? }` —
|
|
9
|
+
* `available` is true only when the feature is enabled AND an engine can run;
|
|
10
|
+
* `engine` is what would answer {@link sttStart} (`"webspeech"` sends audio
|
|
11
|
+
* off-device); `reason` is `"disabled"` or `"unsupported"` when not available.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* const { available, engine } = await api.sttAvailability()
|
|
15
|
+
* if (available) showMicButton({ warnCloud: engine === 'webspeech' })
|
|
16
|
+
*/
|
|
17
|
+
export declare function sttAvailability(): Promise<SttAvailabilityResult>;
|
|
18
|
+
/**
|
|
19
|
+
* Pre-load the on-device dictation model so a later {@link sttStart} resolves
|
|
20
|
+
* instantly (and the mic-permission prompt appears immediately instead of after
|
|
21
|
+
* a download). **Web only** — on iOS the native side manages its own model
|
|
22
|
+
* lifecycle, so the bridge has no `stt.warmup` type and calling it there rejects
|
|
23
|
+
* `requestTypeDoesNotExists`.
|
|
24
|
+
*
|
|
25
|
+
* Fire-and-forget: don't block your UI on it and ignore rejections. It is
|
|
26
|
+
* idempotent (repeated / concurrent calls collapse to a single download) and a
|
|
27
|
+
* no-op when the feature is disabled or the engine has nothing to warm (Web
|
|
28
|
+
* Speech fallback). Call it right after {@link sttAvailability} reports
|
|
29
|
+
* `available` with `engine === 'whisper'`.
|
|
30
|
+
*
|
|
31
|
+
* @returns {Promise<void>} Resolves once the model is ready (or immediately when
|
|
32
|
+
* there's nothing to warm).
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* const { available, engine } = await api.sttAvailability()
|
|
36
|
+
* if (available) {
|
|
37
|
+
* showMicButton()
|
|
38
|
+
* if (engine === 'whisper') api.sttWarmup().catch(() => {}) // background, non-blocking
|
|
39
|
+
* }
|
|
40
|
+
*/
|
|
41
|
+
export declare function sttWarmup(): Promise<void>;
|
|
42
|
+
/**
|
|
43
|
+
* Finalize a dictation session. Resolves with the final full transcript;
|
|
44
|
+
* rejects with `STT_NOT_RECORDING` if the session isn't active.
|
|
45
|
+
*
|
|
46
|
+
* @param {SttStopPayload} payload
|
|
47
|
+
* @param {string} payload.session_id - The id passed to the matching {@link sttStart}.
|
|
48
|
+
* @returns {Promise<SttStopResult>} The final `{ transcript }`.
|
|
49
|
+
*
|
|
50
|
+
* @example
|
|
51
|
+
* const { transcript } = await api.sttStop({ session_id: 'notes-1' })
|
|
52
|
+
*/
|
|
53
|
+
export declare function sttStop(payload: SttStopPayload): Promise<SttStopResult>;
|
|
54
|
+
/**
|
|
55
|
+
* Extract the {@link SttErrorCode} from a rejected `sttStart` / `sttStop`,
|
|
56
|
+
* normalizing across hosts: the iOS bridge rejection (`error_code` /
|
|
57
|
+
* `errorCode`) and Impact web's `{ reason }` / error `message` string. Returns
|
|
58
|
+
* `undefined` if no known code is present.
|
|
59
|
+
*
|
|
60
|
+
* @example
|
|
61
|
+
* try { await api.sttStart({ session_id }) } catch (err) {
|
|
62
|
+
* if (api.sttErrorCode(err) === 'STT_BUSY') showMicInUseHint()
|
|
63
|
+
* }
|
|
64
|
+
*/
|
|
65
|
+
export declare function sttErrorCode(error: unknown): SttErrorCode | undefined;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { TtsErrorCode, TtsSpeakPayload, TtsSpeakResult } from '../../payload.types';
|
|
2
|
+
/**
|
|
3
|
+
* Speak text on the device speaker. Resolves when the utterance FINISHES;
|
|
4
|
+
* rejects with a {@link TtsErrorCode}.
|
|
5
|
+
*
|
|
6
|
+
* @param {TtsSpeakPayload} payload
|
|
7
|
+
* @param {string} payload.text - Text to speak. Empty/whitespace rejects with `TTS_EMPTY_TEXT`.
|
|
8
|
+
* @param {string} [payload.language] - BCP-47/ISO tag (e.g. `"en-US"`); requires
|
|
9
|
+
* an installed offline voice, else rejects with `TTS_VOICE_UNAVAILABLE`. Omit
|
|
10
|
+
* for the system voice.
|
|
11
|
+
* @param {number} [payload.rate] - Speech rate; clamped to the platform min…max.
|
|
12
|
+
* @param {number} [payload.pitch] - Speech pitch; clamped `0.5`…`2.0` (`1.0` = normal).
|
|
13
|
+
* @returns {Promise<TtsSpeakResult>} `{ completed }` — `true` if it finished
|
|
14
|
+
* naturally, `false` if stopped or replaced by a newer `ttsSpeak`.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* const { completed } = await api.ttsSpeak({ text: 'Meeting summary saved.', language: 'en-US' })
|
|
18
|
+
*/
|
|
19
|
+
export declare function ttsSpeak(payload: TtsSpeakPayload): Promise<TtsSpeakResult>;
|
|
20
|
+
/**
|
|
21
|
+
* Stop any in-flight speech. The in-flight {@link ttsSpeak} resolves with
|
|
22
|
+
* `{ completed: false }`.
|
|
23
|
+
*
|
|
24
|
+
* @returns {Promise<void>}
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* await api.ttsStop()
|
|
28
|
+
*/
|
|
29
|
+
export declare function ttsStop(): Promise<void>;
|
|
30
|
+
/**
|
|
31
|
+
* Extract the {@link TtsErrorCode} from a rejected {@link ttsSpeak}, normalizing
|
|
32
|
+
* across hosts: the iOS bridge APIError (`code` / `error_code` / `errorCode`)
|
|
33
|
+
* and a host `{ reason }` / error `message` string. Returns `undefined` if no
|
|
34
|
+
* known code is present.
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* try { await api.ttsSpeak({ text, language }) } catch (err) {
|
|
38
|
+
* if (api.ttsErrorCode(err) === 'TTS_VOICE_UNAVAILABLE') promptVoiceDownload()
|
|
39
|
+
* }
|
|
40
|
+
*/
|
|
41
|
+
export declare function ttsErrorCode(error: unknown): TtsErrorCode | undefined;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
package/lib/sdk/interfaces.d.ts
CHANGED
|
@@ -5,6 +5,7 @@ import { PitcherInstance } from '../types/instance.types';
|
|
|
5
5
|
import { LaunchDarklyEnv } from '../types/launchDarkly.types';
|
|
6
6
|
import { CDP_EVENT_TYPE, CLIENT_TYPE } from '../constants/cdp.const';
|
|
7
7
|
import { PeerConnectivityEvent } from './peer-connectivity';
|
|
8
|
+
import { SttPartialEvent, SttInterruptedEvent } from './payload.types';
|
|
8
9
|
export declare const PITCHER_EVENT: "PITCHER_EVENT";
|
|
9
10
|
export declare enum PitcherMessageType {
|
|
10
11
|
REQUEST = "PITCHER_REQUEST",
|
|
@@ -71,6 +72,10 @@ export interface PitcherEnv {
|
|
|
71
72
|
active_canvas_id?: CanvasRetrieve['id'];
|
|
72
73
|
canvas_correlation_id?: string;
|
|
73
74
|
};
|
|
75
|
+
/** Locale the user picked in the Pitcher shell. Web only — iOS has no picker
|
|
76
|
+
* and reports `device_locale` instead. Apps should prefer this and fall back:
|
|
77
|
+
* `ui_locale || device_locale`. */
|
|
78
|
+
ui_locale?: string;
|
|
74
79
|
device_locale?: string;
|
|
75
80
|
sync_badge_value?: number;
|
|
76
81
|
}
|
|
@@ -113,6 +118,12 @@ export interface StartCallPitcherEvent {
|
|
|
113
118
|
* instead of "Unscheduled".
|
|
114
119
|
*/
|
|
115
120
|
meeting_id?: string;
|
|
121
|
+
/**
|
|
122
|
+
* PIT-7462: start and immediately stop the call, opening the postcall form.
|
|
123
|
+
* The host seeds the call's eventDate from the scheduled meeting record
|
|
124
|
+
* (StartDateTime/EndDateTime) so the form never shows a 0-second duration.
|
|
125
|
+
*/
|
|
126
|
+
jump_to_postcall?: boolean;
|
|
116
127
|
canvas_id?: string;
|
|
117
128
|
edit_mode?: 'true' | 'false';
|
|
118
129
|
post_action?: string;
|
|
@@ -166,7 +177,9 @@ export declare enum PitcherEventName {
|
|
|
166
177
|
ITEM_SHAREBOX_ADD_COMPLETED = "item_sharebox_add_completed",
|
|
167
178
|
SYNC_BADGE_VALUE_REPORTED = "sync_badge_value_reported",
|
|
168
179
|
SYNC_BOX_RESOLVE_ERROR_TAPPED = "sync_box_resolve_error_tapped",
|
|
169
|
-
PEER_CONNECTIVITY_EVENT = "peer_connectivity_event"
|
|
180
|
+
PEER_CONNECTIVITY_EVENT = "peer_connectivity_event",
|
|
181
|
+
STT_PARTIAL = "stt.partial",
|
|
182
|
+
STT_INTERRUPTED = "stt.interrupted"
|
|
170
183
|
}
|
|
171
184
|
export declare enum PitcherBroadcastedEventName {
|
|
172
185
|
UI_SHOW_MODAL = "ui:show-modal",
|
|
@@ -487,6 +500,18 @@ export interface PitcherEventMap {
|
|
|
487
500
|
last_error: string;
|
|
488
501
|
};
|
|
489
502
|
[PitcherEventName.PEER_CONNECTIVITY_EVENT]: PeerConnectivityEvent;
|
|
503
|
+
/**
|
|
504
|
+
* Speech-to-text dictation partial (PITCHER_REQUEST `stt.start` session).
|
|
505
|
+
* Cross-platform (iOS bridge and the web host engine). `text` is the FULL
|
|
506
|
+
* transcript so far — replace, don't append.
|
|
507
|
+
*/
|
|
508
|
+
[PitcherEventName.STT_PARTIAL]: SttPartialEvent;
|
|
509
|
+
/**
|
|
510
|
+
* Speech-to-text dictation session ended WITHOUT a `stt.stop` (e.g. a call
|
|
511
|
+
* recording preempted the mic on iOS, or a fatal capture error on web). Stop
|
|
512
|
+
* waiting for partials and reset the field. Cross-platform.
|
|
513
|
+
*/
|
|
514
|
+
[PitcherEventName.STT_INTERRUPTED]: SttInterruptedEvent;
|
|
490
515
|
[PitcherBroadcastedEventName.UI_SHOW_MODAL]: void;
|
|
491
516
|
[PitcherBroadcastedEventName.UI_HIDE_MODAL]: void;
|
|
492
517
|
[PitcherBroadcastedEventName.FILE_DOWNLOAD]: {
|
package/lib/sdk/main.d.ts
CHANGED
|
@@ -206,10 +206,9 @@ export declare function useApi(options?: ApiOptions): {
|
|
|
206
206
|
openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
|
|
207
207
|
getEnv(): Promise<import('./interfaces').PitcherEnv>;
|
|
208
208
|
updateMyUser(payload: {
|
|
209
|
-
language?:
|
|
209
|
+
language?: string | undefined;
|
|
210
210
|
}): Promise<import('../main.lib').User>;
|
|
211
211
|
isOffline(): Promise<boolean>;
|
|
212
|
-
getLanguages(): Promise<import('./api/modules').Language[]>;
|
|
213
212
|
getCanvases(payload: import('../main.lib').GetCanvasesParams & {
|
|
214
213
|
filters?: Record<string, any>;
|
|
215
214
|
fields?: string;
|
|
@@ -373,6 +372,14 @@ export declare function useApi(options?: ApiOptions): {
|
|
|
373
372
|
canvas_id: import('../main.lib').CanvasRetrieve["id"];
|
|
374
373
|
theme_id: import('../main.lib').CanvasThemeRetrieve["id"];
|
|
375
374
|
}>;
|
|
375
|
+
sttStart(payload: import('./payload.types').SttStartPayload): Promise<void>;
|
|
376
|
+
sttAvailability(): Promise<import('./payload.types').SttAvailabilityResult>;
|
|
377
|
+
sttWarmup(): Promise<void>;
|
|
378
|
+
sttStop(payload: import('./payload.types').SttStopPayload): Promise<import('./payload.types').SttStopResult>;
|
|
379
|
+
sttErrorCode(error: unknown): import('./payload.types').SttErrorCode | undefined;
|
|
380
|
+
ttsSpeak(payload: import('./payload.types').TtsSpeakPayload): Promise<import('./payload.types').TtsSpeakResult>;
|
|
381
|
+
ttsStop(): Promise<void>;
|
|
382
|
+
ttsErrorCode(error: unknown): import('./payload.types').TtsErrorCode | undefined;
|
|
376
383
|
API: import('./api/LowLevelApi').LowLevelApi;
|
|
377
384
|
} | {
|
|
378
385
|
getUsers(payload?: import('../main.lib').GetUsersParams): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
|
|
@@ -503,10 +510,9 @@ export declare function useApi(options?: ApiOptions): {
|
|
|
503
510
|
openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
|
|
504
511
|
getEnv(): Promise<import('./interfaces').PitcherEnv>;
|
|
505
512
|
updateMyUser(payload: {
|
|
506
|
-
language?:
|
|
513
|
+
language?: string | undefined;
|
|
507
514
|
}): Promise<import('../main.lib').User>;
|
|
508
515
|
isOffline(): Promise<boolean>;
|
|
509
|
-
getLanguages(): Promise<import('./api/modules').Language[]>;
|
|
510
516
|
getCanvases(payload: import('../main.lib').GetCanvasesParams & {
|
|
511
517
|
filters?: Record<string, any>;
|
|
512
518
|
fields?: string;
|
|
@@ -670,6 +676,14 @@ export declare function useApi(options?: ApiOptions): {
|
|
|
670
676
|
canvas_id: import('../main.lib').CanvasRetrieve["id"];
|
|
671
677
|
theme_id: import('../main.lib').CanvasThemeRetrieve["id"];
|
|
672
678
|
}>;
|
|
679
|
+
sttStart(payload: import('./payload.types').SttStartPayload): Promise<void>;
|
|
680
|
+
sttAvailability(): Promise<import('./payload.types').SttAvailabilityResult>;
|
|
681
|
+
sttWarmup(): Promise<void>;
|
|
682
|
+
sttStop(payload: import('./payload.types').SttStopPayload): Promise<import('./payload.types').SttStopResult>;
|
|
683
|
+
sttErrorCode(error: unknown): import('./payload.types').SttErrorCode | undefined;
|
|
684
|
+
ttsSpeak(payload: import('./payload.types').TtsSpeakPayload): Promise<import('./payload.types').TtsSpeakResult>;
|
|
685
|
+
ttsStop(): Promise<void>;
|
|
686
|
+
ttsErrorCode(error: unknown): import('./payload.types').TtsErrorCode | undefined;
|
|
673
687
|
API: import('./api/LowLevelApi').LowLevelApi;
|
|
674
688
|
};
|
|
675
689
|
openSharingSettings(payload: import('./api/modules/ui/types.ui').UiOpenSharingSettingsRequest): Promise<import('./api/modules/ui/types.ui').UiOpenSharingSettingsResponse>;
|
|
@@ -745,10 +759,9 @@ export declare function useApi(options?: ApiOptions): {
|
|
|
745
759
|
openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
|
|
746
760
|
getEnv(): Promise<import('./interfaces').PitcherEnv>;
|
|
747
761
|
updateMyUser(payload: {
|
|
748
|
-
language?:
|
|
762
|
+
language?: string | undefined;
|
|
749
763
|
}): Promise<import('../main.lib').User>;
|
|
750
764
|
isOffline(): Promise<boolean>;
|
|
751
|
-
getLanguages(): Promise<import('./api/modules').Language[]>;
|
|
752
765
|
getCanvases(payload: import('../main.lib').GetCanvasesParams & {
|
|
753
766
|
filters?: Record<string, any>;
|
|
754
767
|
fields?: string;
|
|
@@ -903,6 +916,14 @@ export declare function useApi(options?: ApiOptions): {
|
|
|
903
916
|
canvas_id: import('../main.lib').CanvasRetrieve["id"];
|
|
904
917
|
theme_id: import('../main.lib').CanvasThemeRetrieve["id"];
|
|
905
918
|
}>;
|
|
919
|
+
sttStart(payload: import('./payload.types').SttStartPayload): Promise<void>;
|
|
920
|
+
sttAvailability(): Promise<import('./payload.types').SttAvailabilityResult>;
|
|
921
|
+
sttWarmup(): Promise<void>;
|
|
922
|
+
sttStop(payload: import('./payload.types').SttStopPayload): Promise<import('./payload.types').SttStopResult>;
|
|
923
|
+
sttErrorCode(error: unknown): import('./payload.types').SttErrorCode | undefined;
|
|
924
|
+
ttsSpeak(payload: import('./payload.types').TtsSpeakPayload): Promise<import('./payload.types').TtsSpeakResult>;
|
|
925
|
+
ttsStop(): Promise<void>;
|
|
926
|
+
ttsErrorCode(error: unknown): import('./payload.types').TtsErrorCode | undefined;
|
|
906
927
|
API: import('./api/LowLevelApi').LowLevelApi;
|
|
907
928
|
} | {
|
|
908
929
|
broadcast: (event: import('./interfaces').PitcherEvent) => Promise<any>;
|