@unisphere/genie-types 1.8.3 → 1.10.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/index.esm.js +274 -1752
- package/package.json +4 -6
- package/src/index.d.ts +4 -1
- package/src/lib/avatar-runtime/avatar-service-types.d.ts +29 -2
- package/src/lib/avatar-runtime/lobby-visual-types.d.ts +2 -0
- package/src/lib/avatar-runtime/runtime-types.d.ts +9 -0
- package/src/lib/chat-runtime/runtime-flavors/runtime-player-plugin-types.d.ts +1 -1
- package/src/lib/chat-runtime/runtime-flavors/runtime-types.d.ts +2 -1
- package/src/lib/chat-runtime/shared-settings.d.ts +1 -8
- package/src/lib/gtc-agenda-list-tool-runtime/genie-answer-visual-types.d.ts +8 -0
- package/src/lib/gtc-agenda-list-tool-runtime/index.d.ts +2 -0
- package/src/lib/gtc-agenda-list-tool-runtime/runtime-types.d.ts +12 -0
- package/src/lib/gtc-agenda-tool-runtime/genie-answer-visual-types.d.ts +5 -0
- package/src/lib/gtc-agenda-tool-runtime/index.d.ts +2 -0
- package/src/lib/gtc-agenda-tool-runtime/runtime-types.d.ts +12 -0
- package/src/lib/kaltura-video-player-tool-runtime/genie-answer-visual-types.d.ts +5 -0
- package/src/lib/kaltura-video-player-tool-runtime/index.d.ts +2 -0
- package/src/lib/kaltura-video-player-tool-runtime/runtime-types.d.ts +15 -0
- package/src/lib/nvidia-2026-event-tool-runtime/index.d.ts +1 -0
- package/src/lib/nvidia-2026-event-tool-runtime/runtime-types.d.ts +37 -0
- package/src/lib/shared/chat-tools-service-types.d.ts +6 -2
- package/src/lib/utils/index.d.ts +0 -2
- package/src/lib/utils/use-get-widget-service.d.ts +0 -3
- package/src/lib/utils/use-watch-tiny-data-storage.d.ts +0 -4
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@unisphere/genie-types",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.10.0",
|
|
4
4
|
"author": "kaltura",
|
|
5
5
|
"license": "AGPL-3.0",
|
|
6
6
|
"repository": {
|
|
@@ -9,11 +9,9 @@
|
|
|
9
9
|
},
|
|
10
10
|
"types": "./src/index.d.ts",
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@kaltura-corp/unisphere-rtc-core": "^1.22.
|
|
13
|
-
"@unisphere/core": "^1.91.
|
|
14
|
-
"@unisphere/runtime": "^1.90.
|
|
15
|
-
"@unisphere/runtime-react": "^1.83.3",
|
|
16
|
-
"react": "^19.0.0"
|
|
12
|
+
"@kaltura-corp/unisphere-rtc-core": "^1.22.1",
|
|
13
|
+
"@unisphere/core": "^1.91.1",
|
|
14
|
+
"@unisphere/runtime": "^1.90.1"
|
|
17
15
|
},
|
|
18
16
|
"module": "./index.esm.js",
|
|
19
17
|
"type": "module",
|
package/src/index.d.ts
CHANGED
|
@@ -6,8 +6,11 @@ export * from './lib/sources-tool-runtime';
|
|
|
6
6
|
export * from './lib/shared';
|
|
7
7
|
export * from './lib/types';
|
|
8
8
|
export * from './lib/avatar-runtime';
|
|
9
|
-
export * from './lib/utils';
|
|
10
9
|
export * from './lib/admin-runtime';
|
|
11
10
|
export * from './lib/admin-demo-runtime';
|
|
12
11
|
export * from './lib/application-runtime';
|
|
13
12
|
export * from './lib/summary-tool-runtime';
|
|
13
|
+
export * from './lib/nvidia-2026-event-tool-runtime';
|
|
14
|
+
export * from './lib/kaltura-video-player-tool-runtime';
|
|
15
|
+
export * from './lib/gtc-agenda-tool-runtime';
|
|
16
|
+
export * from './lib/gtc-agenda-list-tool-runtime';
|
|
@@ -40,15 +40,30 @@ export interface SimplifiedSocket {
|
|
|
40
40
|
}
|
|
41
41
|
export type AgentData = {
|
|
42
42
|
isTalking: boolean;
|
|
43
|
-
name: string;
|
|
44
43
|
answersCount: number;
|
|
45
44
|
analyticsInfo?: {
|
|
46
45
|
threadId?: string;
|
|
47
46
|
messageId?: string;
|
|
48
47
|
};
|
|
49
48
|
};
|
|
49
|
+
export type AvatarContentData = {
|
|
50
|
+
id: string;
|
|
51
|
+
threadId?: string;
|
|
52
|
+
messageId?: string;
|
|
53
|
+
newTitle?: string;
|
|
54
|
+
type: 'unisphere-tool';
|
|
55
|
+
widgetName: string;
|
|
56
|
+
runtimeName: string;
|
|
57
|
+
} & ({
|
|
58
|
+
status: 'loading' | 'ready';
|
|
59
|
+
settings: any;
|
|
60
|
+
threadId?: string;
|
|
61
|
+
} | {
|
|
62
|
+
status: 'error';
|
|
63
|
+
});
|
|
50
64
|
export interface AvatarConnectionProxInternalType {
|
|
51
65
|
_directEventToServer(message: string, data: any): void;
|
|
66
|
+
_setLocalContent(content: any): void;
|
|
52
67
|
webSocket: TinyDataStoreConsumer<SimplifiedSocket | null>;
|
|
53
68
|
}
|
|
54
69
|
export declare enum DisconnectReasons {
|
|
@@ -75,7 +90,7 @@ export interface AvatarConnectionProxyType {
|
|
|
75
90
|
readonly playerUrl: TinyDataStoreConsumer<string | null>;
|
|
76
91
|
readonly sessionId: TinyDataStoreConsumer<string | null>;
|
|
77
92
|
readonly turnServerURL: TinyDataStoreConsumer<string | null>;
|
|
78
|
-
readonly content: TinyDataStoreConsumer<
|
|
93
|
+
readonly content: TinyDataStoreConsumer<AvatarContentData | null>;
|
|
79
94
|
readonly agentData: TinyDataStoreConsumer<AgentData | null>;
|
|
80
95
|
readonly devicesList: TinyDataStoreConsumer<{
|
|
81
96
|
audioInput: MediaDeviceInfo[];
|
|
@@ -87,7 +102,10 @@ export interface AvatarConnectionProxyType {
|
|
|
87
102
|
suppressNotification?: boolean;
|
|
88
103
|
skipDisconnect?: boolean;
|
|
89
104
|
} | null>;
|
|
105
|
+
readonly threadId: TinyDataStoreConsumer<string | null>;
|
|
90
106
|
readonly id: string;
|
|
107
|
+
sendAskViaText(text: string): void;
|
|
108
|
+
sendDirectEvent(message: string, data: unknown): void;
|
|
91
109
|
destroy(): void;
|
|
92
110
|
}
|
|
93
111
|
export declare const isAvatarConnectionProxyInternalType: (x: any) => x is AvatarConnectionProxInternalType;
|
|
@@ -101,15 +119,24 @@ export interface AvatarServiceType extends UnisphereService {
|
|
|
101
119
|
}>;
|
|
102
120
|
devicesList: TinyDataStoreConsumer<UserDevicesList | null>;
|
|
103
121
|
agentPreviewUrl: TinyDataStoreConsumer<string | null>;
|
|
122
|
+
agentPreviewImageUrl: TinyDataStoreConsumer<string | null>;
|
|
104
123
|
agentStatus: TinyDataStoreConsumer<{
|
|
105
124
|
available: boolean;
|
|
106
125
|
reason?: AgentUnavailabilityReasons;
|
|
107
126
|
} | null>;
|
|
127
|
+
threadId: TinyDataStoreConsumer<string | null>;
|
|
128
|
+
setThreadId(id: string | null): void;
|
|
108
129
|
connect(options?: {
|
|
109
130
|
threadId?: string;
|
|
110
131
|
messageId?: string;
|
|
111
132
|
}): void;
|
|
112
133
|
onPlayerReady(): void;
|
|
134
|
+
getKalturaPlayerParams(): {
|
|
135
|
+
kalturaServerURI: string;
|
|
136
|
+
partnerId: string;
|
|
137
|
+
uiConfId: string;
|
|
138
|
+
ks: string;
|
|
139
|
+
} | null;
|
|
113
140
|
askViaText(text: string): void;
|
|
114
141
|
changeDevice(deviceType: DeviceType, deviceId: string): Promise<boolean>;
|
|
115
142
|
toggleMuteAudio(muted: boolean): Promise<void>;
|
|
@@ -3,5 +3,7 @@ export interface AvatarRuntimeLobbyVisualSettings {
|
|
|
3
3
|
schemaVersion?: string;
|
|
4
4
|
variant?: 'default' | 'mini' | 'buttonOnly';
|
|
5
5
|
isTranslucent?: boolean;
|
|
6
|
+
threadId?: string;
|
|
7
|
+
messageId?: string;
|
|
6
8
|
}
|
|
7
9
|
export declare const avatarRuntimeLobbyVisualSettingsSchema: ValidatorSchema;
|
|
@@ -8,6 +8,8 @@ export type AvatarRuntime = UnisphereRuntimeBaseType<AvatarRuntimeSettings> & {
|
|
|
8
8
|
connect(): void;
|
|
9
9
|
disconnect(): void;
|
|
10
10
|
isConnected: TinyDataStoreConsumer<boolean>;
|
|
11
|
+
threadId: TinyDataStoreConsumer<string | null>;
|
|
12
|
+
setThreadId(id: string | null): void;
|
|
11
13
|
};
|
|
12
14
|
export interface AvatarRuntimeSettings {
|
|
13
15
|
schemaVersion?: string;
|
|
@@ -18,9 +20,16 @@ export interface AvatarRuntimeSettings {
|
|
|
18
20
|
roomId: string;
|
|
19
21
|
flowId: string;
|
|
20
22
|
loadingVideoURL?: string;
|
|
23
|
+
avatarId?: string;
|
|
24
|
+
previewImageUrl?: string;
|
|
25
|
+
agentMode?: boolean;
|
|
26
|
+
noiseReductionEnabled?: boolean;
|
|
21
27
|
kaltura: {
|
|
22
28
|
ks: string;
|
|
23
29
|
entryId?: string;
|
|
30
|
+
kalturaServerURI?: string;
|
|
31
|
+
partnerId?: string;
|
|
32
|
+
uiConfId?: string;
|
|
24
33
|
};
|
|
25
34
|
}
|
|
26
35
|
export declare const avatarRuntimeSettingsSchema: ValidatorSchema;
|
|
@@ -13,8 +13,8 @@ export interface ChatRuntimePlayerPluginSettings {
|
|
|
13
13
|
ks: string;
|
|
14
14
|
partnerId: string;
|
|
15
15
|
schemaVersion?: '1';
|
|
16
|
-
kalturaServerURI: string;
|
|
17
16
|
integrations?: GlobalChatSettings['integrations'];
|
|
18
17
|
shareUrl?: GlobalChatSettings['shareUrl'];
|
|
18
|
+
avatarContainerMode?: 'dialog' | 'contained';
|
|
19
19
|
}
|
|
20
20
|
export declare const chatRuntimePlayerPluginSettingsSchema: ValidatorSchema;
|
|
@@ -13,9 +13,10 @@ export interface ChatRuntimeSettings {
|
|
|
13
13
|
schemaVersion?: '1';
|
|
14
14
|
genieServerUrl?: string;
|
|
15
15
|
partnerId: string;
|
|
16
|
-
kalturaServerURI: string;
|
|
17
16
|
ks: string;
|
|
18
17
|
entryId?: string;
|
|
18
|
+
agentMode?: boolean;
|
|
19
|
+
avatarContainerMode?: 'dialog' | 'contained';
|
|
19
20
|
getSourceUrl?: GlobalChatSettings['getSourceUrl'];
|
|
20
21
|
shareUrl?: GlobalChatSettings['shareUrl'];
|
|
21
22
|
branding?: {
|
|
@@ -1,10 +1,4 @@
|
|
|
1
1
|
import { ValidatorSchema } from '@unisphere/core';
|
|
2
|
-
export interface MarketoIntegration {
|
|
3
|
-
type: 'form';
|
|
4
|
-
quota: number;
|
|
5
|
-
formId: string;
|
|
6
|
-
blocker: boolean;
|
|
7
|
-
}
|
|
8
2
|
export interface ChatBranding {
|
|
9
3
|
kalturaLogo?: boolean;
|
|
10
4
|
}
|
|
@@ -35,11 +29,10 @@ export interface GlobalChatSettings {
|
|
|
35
29
|
messageId: string;
|
|
36
30
|
}) => string;
|
|
37
31
|
};
|
|
38
|
-
|
|
32
|
+
avatarContainerMode: 'dialog' | 'contained' | null;
|
|
39
33
|
integrations?: {
|
|
40
34
|
avatar?: AvatarIntegration;
|
|
41
35
|
kaltura?: KalturaIntegration;
|
|
42
|
-
marketo?: MarketoIntegration;
|
|
43
36
|
};
|
|
44
37
|
}
|
|
45
38
|
export declare const integrationsSchema: ValidatorSchema;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { ValidatorSchema } from '@unisphere/core';
|
|
2
|
+
export interface GtcAgendaListToolRuntimeGenieAnswerVisualSettings {
|
|
3
|
+
schemaVersion?: string;
|
|
4
|
+
sessions: {
|
|
5
|
+
id: string;
|
|
6
|
+
}[];
|
|
7
|
+
}
|
|
8
|
+
export declare const gtcAgendaListToolRuntimeGenieAnswerVisualSettingsSchema: ValidatorSchema;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { ValidatorSchema } from '@unisphere/core';
|
|
2
|
+
import { UnisphereRuntimeBaseType } from '@unisphere/runtime';
|
|
3
|
+
import { widgetName } from '../widget-types';
|
|
4
|
+
export declare const GtcAgendaListToolRuntimeName: "gtc-agenda-list-tool";
|
|
5
|
+
export type GtcAgendaListToolRuntime = UnisphereRuntimeBaseType<GtcAgendaListToolRuntimeSettings> & {
|
|
6
|
+
readonly widgetName: typeof widgetName;
|
|
7
|
+
readonly runtimeName: typeof GtcAgendaListToolRuntimeName;
|
|
8
|
+
};
|
|
9
|
+
export interface GtcAgendaListToolRuntimeSettings {
|
|
10
|
+
schemaVersion?: string;
|
|
11
|
+
}
|
|
12
|
+
export declare const gtcAgendaListToolRuntimeSettingsSchema: ValidatorSchema;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { ValidatorSchema } from '@unisphere/core';
|
|
2
|
+
import { UnisphereRuntimeBaseType } from '@unisphere/runtime';
|
|
3
|
+
import { widgetName } from '../widget-types';
|
|
4
|
+
export declare const GtcAgendaToolRuntimeName: "gtc-agenda-tool";
|
|
5
|
+
export type GtcAgendaToolRuntime = UnisphereRuntimeBaseType<GtcAgendaToolRuntimeSettings> & {
|
|
6
|
+
readonly widgetName: typeof widgetName;
|
|
7
|
+
readonly runtimeName: typeof GtcAgendaToolRuntimeName;
|
|
8
|
+
};
|
|
9
|
+
export interface GtcAgendaToolRuntimeSettings {
|
|
10
|
+
schemaVersion?: string;
|
|
11
|
+
}
|
|
12
|
+
export declare const gtcAgendaToolRuntimeSettingsSchema: ValidatorSchema;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { ValidatorSchema } from '@unisphere/core';
|
|
2
|
+
import { UnisphereRuntimeBaseType } from '@unisphere/runtime';
|
|
3
|
+
import { widgetName } from '../widget-types';
|
|
4
|
+
export declare const KalturaVideoPlayerToolRuntimeName: "kaltura-video-player-tool";
|
|
5
|
+
export type KalturaVideoPlayerToolRuntime = UnisphereRuntimeBaseType<KalturaVideoPlayerToolRuntimeSettings> & {
|
|
6
|
+
readonly widgetName: typeof widgetName;
|
|
7
|
+
readonly runtimeName: typeof KalturaVideoPlayerToolRuntimeName;
|
|
8
|
+
};
|
|
9
|
+
export interface KalturaVideoPlayerToolRuntimeSettings {
|
|
10
|
+
kalturaServerURI: string;
|
|
11
|
+
partnerId: string;
|
|
12
|
+
uiConfId: string;
|
|
13
|
+
ks: string;
|
|
14
|
+
}
|
|
15
|
+
export declare const kalturaVideoPlayerToolRuntimeSettingsSchema: ValidatorSchema;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './runtime-types';
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { ValidatorSchema } from '@unisphere/core';
|
|
2
|
+
import { UnisphereRuntimeBaseType, UnisphereService } from '@unisphere/runtime';
|
|
3
|
+
import { widgetName } from '../widget-types';
|
|
4
|
+
export declare const Nvidia2026EventToolRuntimeName: "nvidia-2026-event-tool";
|
|
5
|
+
export type Nvidia2026EventToolRuntime = UnisphereRuntimeBaseType<Nvidia2026EventToolRuntimeSettings> & {
|
|
6
|
+
readonly widgetName: typeof widgetName;
|
|
7
|
+
readonly runtimeName: typeof Nvidia2026EventToolRuntimeName;
|
|
8
|
+
};
|
|
9
|
+
export interface Nvidia2026EventToolRuntimeSettings {
|
|
10
|
+
schemaVersion?: '1';
|
|
11
|
+
}
|
|
12
|
+
export declare const nvidia2026EventToolRuntimeSettingsSchema: ValidatorSchema;
|
|
13
|
+
export interface NvidiaSession {
|
|
14
|
+
sessionId: string;
|
|
15
|
+
title: string;
|
|
16
|
+
summary: string;
|
|
17
|
+
startDate: string;
|
|
18
|
+
endDate: string;
|
|
19
|
+
topic: string;
|
|
20
|
+
industry: string;
|
|
21
|
+
technicalLevel: string;
|
|
22
|
+
intendedAudience: string;
|
|
23
|
+
nvidiaTechnology: string;
|
|
24
|
+
keyTakeaways: string;
|
|
25
|
+
speakers: string;
|
|
26
|
+
language: string;
|
|
27
|
+
location: string;
|
|
28
|
+
type: string;
|
|
29
|
+
room: string;
|
|
30
|
+
entryId: string;
|
|
31
|
+
}
|
|
32
|
+
export interface Nvidia2026EventServiceType extends UnisphereService {
|
|
33
|
+
id: 'unisphere.widgets.genie.nvidia-2026-event';
|
|
34
|
+
getEntryId(sessionId: string): string | null;
|
|
35
|
+
getSession(sessionId: string): NvidiaSession | null;
|
|
36
|
+
getSessionsList(sessionIds: string[]): NvidiaSession[];
|
|
37
|
+
}
|
|
@@ -14,8 +14,6 @@ type ClassGenieGetClipPlayerPosterUrlData = {
|
|
|
14
14
|
};
|
|
15
15
|
export interface GenieChatServiceType extends UnisphereService {
|
|
16
16
|
id: 'unisphere.widgets.genie.chat';
|
|
17
|
-
canPlayVideo?: () => Promise<boolean>;
|
|
18
|
-
canGetAnswer?: (() => Promise<boolean>) | undefined;
|
|
19
17
|
getClipPlayerUrl?: (source: ClassGenieGetClipPlayerUrlData) => string | null;
|
|
20
18
|
getClipPlayerPosterUrl: (source: ClassGenieGetClipPlayerPosterUrlData) => string;
|
|
21
19
|
getEntrySourceUrl: (entryId: string, startTime?: number) => string;
|
|
@@ -33,6 +31,12 @@ export interface GenieChatServiceType extends UnisphereService {
|
|
|
33
31
|
setAnswerModel(model: AnswerModel | undefined): void;
|
|
34
32
|
getAnswerModel(): AnswerModel | undefined;
|
|
35
33
|
getUiconfId(): string | null;
|
|
34
|
+
getKalturaPlayerParams(): {
|
|
35
|
+
kalturaServerURI: string;
|
|
36
|
+
partnerId: string;
|
|
37
|
+
uiConfId: string;
|
|
38
|
+
ks: string;
|
|
39
|
+
};
|
|
36
40
|
setContainerRef(ref: HTMLDivElement | null): void;
|
|
37
41
|
getContainerRef(): HTMLDivElement | null;
|
|
38
42
|
get globalChatSettings(): GlobalChatSettings;
|
package/src/lib/utils/index.d.ts
DELETED