@navai/voice-frontend 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +95 -0
- package/dist/index.cjs +717 -0
- package/dist/index.d.cts +106 -0
- package/dist/index.d.ts +106 -0
- package/dist/index.js +685 -0
- package/package.json +36 -0
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import { RealtimeAgent } from '@openai/agents/realtime';
|
|
2
|
+
|
|
3
|
+
type NavaiFunctionPayload = Record<string, unknown>;
|
|
4
|
+
type NavaiFunctionContext = {
|
|
5
|
+
navigate: (path: string) => void;
|
|
6
|
+
};
|
|
7
|
+
type NavaiFunctionDefinition = {
|
|
8
|
+
name: string;
|
|
9
|
+
description: string;
|
|
10
|
+
source: string;
|
|
11
|
+
run: (payload: NavaiFunctionPayload, context: NavaiFunctionContext) => Promise<unknown> | unknown;
|
|
12
|
+
};
|
|
13
|
+
type NavaiFunctionsRegistry = {
|
|
14
|
+
byName: Map<string, NavaiFunctionDefinition>;
|
|
15
|
+
ordered: NavaiFunctionDefinition[];
|
|
16
|
+
warnings: string[];
|
|
17
|
+
};
|
|
18
|
+
type NavaiFunctionModuleLoaders = Record<string, () => Promise<unknown>>;
|
|
19
|
+
declare function loadNavaiFunctions(functionModuleLoaders: NavaiFunctionModuleLoaders): Promise<NavaiFunctionsRegistry>;
|
|
20
|
+
|
|
21
|
+
type NavaiRoute = {
|
|
22
|
+
name: string;
|
|
23
|
+
path: string;
|
|
24
|
+
description: string;
|
|
25
|
+
synonyms?: string[];
|
|
26
|
+
};
|
|
27
|
+
declare function resolveNavaiRoute(input: string, routes?: NavaiRoute[]): string | null;
|
|
28
|
+
declare function getNavaiRoutePromptLines(routes?: NavaiRoute[]): string[];
|
|
29
|
+
|
|
30
|
+
type NavaiBackendFunctionDefinition = {
|
|
31
|
+
name: string;
|
|
32
|
+
description?: string;
|
|
33
|
+
source?: string;
|
|
34
|
+
};
|
|
35
|
+
type ExecuteNavaiBackendFunctionInput = {
|
|
36
|
+
functionName: string;
|
|
37
|
+
payload: Record<string, unknown> | null;
|
|
38
|
+
};
|
|
39
|
+
type ExecuteNavaiBackendFunction = (input: ExecuteNavaiBackendFunctionInput) => Promise<unknown> | unknown;
|
|
40
|
+
type BuildNavaiAgentOptions = NavaiFunctionContext & {
|
|
41
|
+
routes: NavaiRoute[];
|
|
42
|
+
functionModuleLoaders?: NavaiFunctionModuleLoaders;
|
|
43
|
+
backendFunctions?: NavaiBackendFunctionDefinition[];
|
|
44
|
+
executeBackendFunction?: ExecuteNavaiBackendFunction;
|
|
45
|
+
agentName?: string;
|
|
46
|
+
baseInstructions?: string;
|
|
47
|
+
};
|
|
48
|
+
type BuildNavaiAgentResult = {
|
|
49
|
+
agent: RealtimeAgent;
|
|
50
|
+
warnings: string[];
|
|
51
|
+
};
|
|
52
|
+
declare function buildNavaiAgent(options: BuildNavaiAgentOptions): Promise<BuildNavaiAgentResult>;
|
|
53
|
+
|
|
54
|
+
type NavaiFrontendEnv$1 = Record<string, string | undefined>;
|
|
55
|
+
type CreateClientSecretInput = {
|
|
56
|
+
model?: string;
|
|
57
|
+
voice?: string;
|
|
58
|
+
instructions?: string;
|
|
59
|
+
language?: string;
|
|
60
|
+
voiceAccent?: string;
|
|
61
|
+
voiceTone?: string;
|
|
62
|
+
apiKey?: string;
|
|
63
|
+
};
|
|
64
|
+
type CreateClientSecretOutput = {
|
|
65
|
+
value: string;
|
|
66
|
+
expires_at?: number;
|
|
67
|
+
};
|
|
68
|
+
type BackendFunctionsResult = {
|
|
69
|
+
functions: NavaiBackendFunctionDefinition[];
|
|
70
|
+
warnings: string[];
|
|
71
|
+
};
|
|
72
|
+
type CreateNavaiBackendClientOptions = {
|
|
73
|
+
apiBaseUrl?: string;
|
|
74
|
+
env?: NavaiFrontendEnv$1;
|
|
75
|
+
fetchImpl?: typeof fetch;
|
|
76
|
+
clientSecretPath?: string;
|
|
77
|
+
functionsListPath?: string;
|
|
78
|
+
functionsExecutePath?: string;
|
|
79
|
+
};
|
|
80
|
+
type NavaiBackendClient = {
|
|
81
|
+
createClientSecret: (input?: CreateClientSecretInput) => Promise<CreateClientSecretOutput>;
|
|
82
|
+
listFunctions: () => Promise<BackendFunctionsResult>;
|
|
83
|
+
executeFunction: ExecuteNavaiBackendFunction;
|
|
84
|
+
};
|
|
85
|
+
declare function createNavaiBackendClient(options?: CreateNavaiBackendClientOptions): NavaiBackendClient;
|
|
86
|
+
|
|
87
|
+
type NavaiFrontendEnv = Record<string, unknown>;
|
|
88
|
+
type ResolveNavaiFrontendRuntimeConfigOptions = {
|
|
89
|
+
moduleLoaders: NavaiFunctionModuleLoaders;
|
|
90
|
+
defaultRoutes: NavaiRoute[];
|
|
91
|
+
env?: NavaiFrontendEnv;
|
|
92
|
+
routesFile?: string;
|
|
93
|
+
functionsFolders?: string;
|
|
94
|
+
modelOverride?: string;
|
|
95
|
+
defaultRoutesFile?: string;
|
|
96
|
+
defaultFunctionsFolder?: string;
|
|
97
|
+
};
|
|
98
|
+
type ResolveNavaiFrontendRuntimeConfigResult = {
|
|
99
|
+
routes: NavaiRoute[];
|
|
100
|
+
functionModuleLoaders: NavaiFunctionModuleLoaders;
|
|
101
|
+
modelOverride?: string;
|
|
102
|
+
warnings: string[];
|
|
103
|
+
};
|
|
104
|
+
declare function resolveNavaiFrontendRuntimeConfig(options: ResolveNavaiFrontendRuntimeConfigOptions): Promise<ResolveNavaiFrontendRuntimeConfigResult>;
|
|
105
|
+
|
|
106
|
+
export { type BuildNavaiAgentOptions, type BuildNavaiAgentResult, type CreateNavaiBackendClientOptions, type ExecuteNavaiBackendFunction, type ExecuteNavaiBackendFunctionInput, type NavaiBackendClient, type NavaiBackendFunctionDefinition, type NavaiFunctionContext, type NavaiFunctionDefinition, type NavaiFunctionModuleLoaders, type NavaiFunctionPayload, type NavaiFunctionsRegistry, type NavaiRoute, type ResolveNavaiFrontendRuntimeConfigOptions, type ResolveNavaiFrontendRuntimeConfigResult, buildNavaiAgent, createNavaiBackendClient, getNavaiRoutePromptLines, loadNavaiFunctions, resolveNavaiFrontendRuntimeConfig, resolveNavaiRoute };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import { RealtimeAgent } from '@openai/agents/realtime';
|
|
2
|
+
|
|
3
|
+
type NavaiFunctionPayload = Record<string, unknown>;
|
|
4
|
+
type NavaiFunctionContext = {
|
|
5
|
+
navigate: (path: string) => void;
|
|
6
|
+
};
|
|
7
|
+
type NavaiFunctionDefinition = {
|
|
8
|
+
name: string;
|
|
9
|
+
description: string;
|
|
10
|
+
source: string;
|
|
11
|
+
run: (payload: NavaiFunctionPayload, context: NavaiFunctionContext) => Promise<unknown> | unknown;
|
|
12
|
+
};
|
|
13
|
+
type NavaiFunctionsRegistry = {
|
|
14
|
+
byName: Map<string, NavaiFunctionDefinition>;
|
|
15
|
+
ordered: NavaiFunctionDefinition[];
|
|
16
|
+
warnings: string[];
|
|
17
|
+
};
|
|
18
|
+
type NavaiFunctionModuleLoaders = Record<string, () => Promise<unknown>>;
|
|
19
|
+
declare function loadNavaiFunctions(functionModuleLoaders: NavaiFunctionModuleLoaders): Promise<NavaiFunctionsRegistry>;
|
|
20
|
+
|
|
21
|
+
type NavaiRoute = {
|
|
22
|
+
name: string;
|
|
23
|
+
path: string;
|
|
24
|
+
description: string;
|
|
25
|
+
synonyms?: string[];
|
|
26
|
+
};
|
|
27
|
+
declare function resolveNavaiRoute(input: string, routes?: NavaiRoute[]): string | null;
|
|
28
|
+
declare function getNavaiRoutePromptLines(routes?: NavaiRoute[]): string[];
|
|
29
|
+
|
|
30
|
+
type NavaiBackendFunctionDefinition = {
|
|
31
|
+
name: string;
|
|
32
|
+
description?: string;
|
|
33
|
+
source?: string;
|
|
34
|
+
};
|
|
35
|
+
type ExecuteNavaiBackendFunctionInput = {
|
|
36
|
+
functionName: string;
|
|
37
|
+
payload: Record<string, unknown> | null;
|
|
38
|
+
};
|
|
39
|
+
type ExecuteNavaiBackendFunction = (input: ExecuteNavaiBackendFunctionInput) => Promise<unknown> | unknown;
|
|
40
|
+
type BuildNavaiAgentOptions = NavaiFunctionContext & {
|
|
41
|
+
routes: NavaiRoute[];
|
|
42
|
+
functionModuleLoaders?: NavaiFunctionModuleLoaders;
|
|
43
|
+
backendFunctions?: NavaiBackendFunctionDefinition[];
|
|
44
|
+
executeBackendFunction?: ExecuteNavaiBackendFunction;
|
|
45
|
+
agentName?: string;
|
|
46
|
+
baseInstructions?: string;
|
|
47
|
+
};
|
|
48
|
+
type BuildNavaiAgentResult = {
|
|
49
|
+
agent: RealtimeAgent;
|
|
50
|
+
warnings: string[];
|
|
51
|
+
};
|
|
52
|
+
declare function buildNavaiAgent(options: BuildNavaiAgentOptions): Promise<BuildNavaiAgentResult>;
|
|
53
|
+
|
|
54
|
+
type NavaiFrontendEnv$1 = Record<string, string | undefined>;
|
|
55
|
+
type CreateClientSecretInput = {
|
|
56
|
+
model?: string;
|
|
57
|
+
voice?: string;
|
|
58
|
+
instructions?: string;
|
|
59
|
+
language?: string;
|
|
60
|
+
voiceAccent?: string;
|
|
61
|
+
voiceTone?: string;
|
|
62
|
+
apiKey?: string;
|
|
63
|
+
};
|
|
64
|
+
type CreateClientSecretOutput = {
|
|
65
|
+
value: string;
|
|
66
|
+
expires_at?: number;
|
|
67
|
+
};
|
|
68
|
+
type BackendFunctionsResult = {
|
|
69
|
+
functions: NavaiBackendFunctionDefinition[];
|
|
70
|
+
warnings: string[];
|
|
71
|
+
};
|
|
72
|
+
type CreateNavaiBackendClientOptions = {
|
|
73
|
+
apiBaseUrl?: string;
|
|
74
|
+
env?: NavaiFrontendEnv$1;
|
|
75
|
+
fetchImpl?: typeof fetch;
|
|
76
|
+
clientSecretPath?: string;
|
|
77
|
+
functionsListPath?: string;
|
|
78
|
+
functionsExecutePath?: string;
|
|
79
|
+
};
|
|
80
|
+
type NavaiBackendClient = {
|
|
81
|
+
createClientSecret: (input?: CreateClientSecretInput) => Promise<CreateClientSecretOutput>;
|
|
82
|
+
listFunctions: () => Promise<BackendFunctionsResult>;
|
|
83
|
+
executeFunction: ExecuteNavaiBackendFunction;
|
|
84
|
+
};
|
|
85
|
+
declare function createNavaiBackendClient(options?: CreateNavaiBackendClientOptions): NavaiBackendClient;
|
|
86
|
+
|
|
87
|
+
type NavaiFrontendEnv = Record<string, unknown>;
|
|
88
|
+
type ResolveNavaiFrontendRuntimeConfigOptions = {
|
|
89
|
+
moduleLoaders: NavaiFunctionModuleLoaders;
|
|
90
|
+
defaultRoutes: NavaiRoute[];
|
|
91
|
+
env?: NavaiFrontendEnv;
|
|
92
|
+
routesFile?: string;
|
|
93
|
+
functionsFolders?: string;
|
|
94
|
+
modelOverride?: string;
|
|
95
|
+
defaultRoutesFile?: string;
|
|
96
|
+
defaultFunctionsFolder?: string;
|
|
97
|
+
};
|
|
98
|
+
type ResolveNavaiFrontendRuntimeConfigResult = {
|
|
99
|
+
routes: NavaiRoute[];
|
|
100
|
+
functionModuleLoaders: NavaiFunctionModuleLoaders;
|
|
101
|
+
modelOverride?: string;
|
|
102
|
+
warnings: string[];
|
|
103
|
+
};
|
|
104
|
+
declare function resolveNavaiFrontendRuntimeConfig(options: ResolveNavaiFrontendRuntimeConfigOptions): Promise<ResolveNavaiFrontendRuntimeConfigResult>;
|
|
105
|
+
|
|
106
|
+
export { type BuildNavaiAgentOptions, type BuildNavaiAgentResult, type CreateNavaiBackendClientOptions, type ExecuteNavaiBackendFunction, type ExecuteNavaiBackendFunctionInput, type NavaiBackendClient, type NavaiBackendFunctionDefinition, type NavaiFunctionContext, type NavaiFunctionDefinition, type NavaiFunctionModuleLoaders, type NavaiFunctionPayload, type NavaiFunctionsRegistry, type NavaiRoute, type ResolveNavaiFrontendRuntimeConfigOptions, type ResolveNavaiFrontendRuntimeConfigResult, buildNavaiAgent, createNavaiBackendClient, getNavaiRoutePromptLines, loadNavaiFunctions, resolveNavaiFrontendRuntimeConfig, resolveNavaiRoute };
|