@sermas/sermas-toolkit-node-sdk 1.0.0-alpha.9 → 1.0.0-alpha.90

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 (41) hide show
  1. package/README.md +16 -0
  2. package/index.cjs +2 -0
  3. package/index.cjs.map +1 -0
  4. package/index.d.cts +150 -0
  5. package/index.d.ts +150 -0
  6. package/index.js +2 -0
  7. package/index.js.map +1 -0
  8. package/package.json +15 -16
  9. package/dist/cjs/config/defaults.js +0 -18
  10. package/dist/cjs/config/logger.js +0 -10
  11. package/dist/cjs/config/util.js +0 -70
  12. package/dist/cjs/dto/session.js +0 -2
  13. package/dist/cjs/index.js +0 -16
  14. package/dist/cjs/modules/auth.js +0 -238
  15. package/dist/cjs/modules/openai.js +0 -63
  16. package/dist/cjs/modules/sermas.js +0 -233
  17. package/dist/cjs/modules/store.js +0 -177
  18. package/dist/cjs/modules/tools.js +0 -44
  19. package/dist/cjs/modules/ui.js +0 -124
  20. package/dist/esm/config/defaults.js +0 -15
  21. package/dist/esm/config/logger.js +0 -6
  22. package/dist/esm/config/util.js +0 -39
  23. package/dist/esm/dto/session.js +0 -1
  24. package/dist/esm/index.js +0 -6
  25. package/dist/esm/modules/auth.js +0 -210
  26. package/dist/esm/modules/openai.js +0 -57
  27. package/dist/esm/modules/sermas.js +0 -230
  28. package/dist/esm/modules/store.js +0 -174
  29. package/dist/esm/modules/tools.js +0 -41
  30. package/dist/esm/modules/ui.js +0 -121
  31. package/dist/types/config/defaults.d.ts +0 -15
  32. package/dist/types/config/logger.d.ts +0 -1
  33. package/dist/types/config/util.d.ts +0 -6
  34. package/dist/types/dto/session.d.ts +0 -7
  35. package/dist/types/index.d.ts +0 -8
  36. package/dist/types/modules/auth.d.ts +0 -30
  37. package/dist/types/modules/openai.d.ts +0 -18
  38. package/dist/types/modules/sermas.d.ts +0 -36
  39. package/dist/types/modules/store.d.ts +0 -21
  40. package/dist/types/modules/tools.d.ts +0 -15
  41. package/dist/types/modules/ui.d.ts +0 -24
@@ -1,41 +0,0 @@
1
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
- return new (P || (P = Promise))(function (resolve, reject) {
4
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
- step((generator = generator.apply(thisArg, _arguments || [])).next());
8
- });
9
- };
10
- class Tools {
11
- constructor(sermasApp) {
12
- this.sermas = sermasApp;
13
- }
14
- reset(session) {
15
- return __awaiter(this, void 0, void 0, function* () {
16
- yield this.sermas.setTools(session.sessionId, []);
17
- });
18
- }
19
- set(session, tools) {
20
- return __awaiter(this, void 0, void 0, function* () {
21
- yield this.sermas.setTools(session.sessionId, tools);
22
- });
23
- }
24
- add(session, tools, options) {
25
- return __awaiter(this, void 0, void 0, function* () {
26
- yield this.sermas.addTools(session.sessionId, tools, options);
27
- });
28
- }
29
- getSchemaValues(tool) {
30
- const values = {};
31
- if (!tool.schema)
32
- return values;
33
- tool.schema.forEach((schema) => (values[schema.parameter] = schema.value));
34
- return values;
35
- }
36
- getSchemaValue(tool, parameterName) {
37
- const values = this.getSchemaValues(tool);
38
- return values[parameterName];
39
- }
40
- }
41
- export { Tools };
@@ -1,121 +0,0 @@
1
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
- return new (P || (P = Promise))(function (resolve, reject) {
4
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
- step((generator = generator.apply(thisArg, _arguments || [])).next());
8
- });
9
- };
10
- import { sleep } from "openai/core";
11
- import { ulid } from "ulidx";
12
- import { createLogger } from "../config/logger.js";
13
- class UI {
14
- constructor(sermas, store) {
15
- this.logger = createLogger(UI.name);
16
- this.backMenuOptions = [];
17
- this.sermas = sermas;
18
- this.store = store;
19
- this.sermas.emitter.on("session", this.onSessionChange.bind(this));
20
- }
21
- // @OnEvent("session")
22
- onSessionChange(ev) {
23
- return __awaiter(this, void 0, void 0, function* () {
24
- if (!ev.record.sessionId)
25
- return;
26
- const session = yield this.store.getSessionWrapper(ev.record.sessionId);
27
- switch (ev.operation) {
28
- case "removed":
29
- if (!session)
30
- return;
31
- yield this.sendClearScreen(session);
32
- break;
33
- }
34
- });
35
- }
36
- createBackButton(value) {
37
- this.backMenuOptions = Array.from(new Set([...this.backMenuOptions, value]));
38
- const button = {
39
- value,
40
- classes: ["is-light"],
41
- };
42
- return button;
43
- }
44
- sendBackMenu(session, labels) {
45
- return __awaiter(this, void 0, void 0, function* () {
46
- labels = typeof labels === "string" ? [labels] : labels;
47
- yield this.sendButtons(session, "", labels.map((value) => this.createBackButton(value)), undefined, {
48
- ttsEnabled: false,
49
- });
50
- });
51
- }
52
- sendMenuButtons(session, buttons) {
53
- return __awaiter(this, void 0, void 0, function* () {
54
- yield this.sendButtons(session, "", buttons, undefined, {
55
- ttsEnabled: false,
56
- });
57
- });
58
- }
59
- sendAgentMessage(session, message, messageLanguage) {
60
- return __awaiter(this, void 0, void 0, function* () {
61
- var _a, _b;
62
- const app = yield this.sermas.getApp();
63
- if (!app) {
64
- this.logger.warn(`app is not available`);
65
- return;
66
- }
67
- const filtered = (_b = (_a = app.repository) === null || _a === void 0 ? void 0 : _a.avatars) === null || _b === void 0 ? void 0 : _b.filter((a) => a.name === app.settings.avatar);
68
- const gender = filtered.length ? filtered[0].gender : undefined;
69
- yield this.sermas.sendChatMessage(Object.assign(Object.assign({}, session), { text: message, appId: app.appId, actor: "agent", gender, language: messageLanguage, chunkId: this.getChunkId() }));
70
- });
71
- }
72
- sendButtons(session_1, label_1, list_1) {
73
- return __awaiter(this, arguments, void 0, function* (session, label, list, metadata = {}, options = {
74
- clearScreen: false,
75
- ttsEnabled: true,
76
- stopSpeech: false,
77
- }) {
78
- if (!session) {
79
- this.logger.warn(`[sendButtons] Session is empty`);
80
- return;
81
- }
82
- const ev = Object.assign(Object.assign({}, session), { metadata,
83
- options, content: {
84
- label,
85
- list: list.map((button) => {
86
- if (typeof button === "string")
87
- return { value: button };
88
- return button;
89
- }),
90
- }, contentType: "buttons", chunkId: this.getChunkId() });
91
- yield this.sermas.sendUiContent(ev);
92
- });
93
- }
94
- sendClearScreen(session) {
95
- return __awaiter(this, void 0, void 0, function* () {
96
- const ev = Object.assign(Object.assign({}, session), { metadata: {}, options: {
97
- clearScreen: true,
98
- stopSpeech: true,
99
- }, content: {}, contentType: "clear-screen" });
100
- yield this.sermas.sendUiContent(ev);
101
- yield sleep(500);
102
- });
103
- }
104
- sendImage(session, data, width, height) {
105
- return __awaiter(this, void 0, void 0, function* () {
106
- this.logger.info(`Send image sessionId=${session.sessionId} appId=${session.appId}`);
107
- const ev = Object.assign(Object.assign({}, session), { metadata: {}, options: {
108
- clearScreen: false,
109
- stopSpeech: false,
110
- }, content: { src: data, alt: "no image", width, height }, contentType: "image" });
111
- yield this.sermas.sendUiContent(ev);
112
- });
113
- }
114
- getChunkId(ts) {
115
- return ulid(ts ? new Date(ts).getTime() : undefined);
116
- }
117
- matchBackMenu(selection) {
118
- return selection && this.backMenuOptions.indexOf(selection) > -1;
119
- }
120
- }
121
- export { UI };
@@ -1,15 +0,0 @@
1
- export declare const defaults: {
2
- readonly auth: {
3
- readonly PUBLIC_AUTH_URL: "http://172.17.0.1:8080/keycloak";
4
- readonly PUBLIC_AUTH_REALM: "sermas-local";
5
- readonly PRIVATE_AUTH_CLIENT_ID: "platform";
6
- readonly PRIVATE_AUTH_CLIENT_SECRET: "platform";
7
- readonly PRIVATE_API_BASE_URL: "http://api:3000/api";
8
- };
9
- readonly sermas: {
10
- readonly SERMAS_BASE_URL: "http://localhost:8080";
11
- readonly SERMAS_CLIENT_ID: "sermas-client";
12
- readonly SERMAS_CLIENT_SECRET: "s3cr3t";
13
- readonly SERMAS_APPID: "sermas";
14
- };
15
- };
@@ -1 +0,0 @@
1
- export declare const createLogger: (name: string) => import("winston").Logger;
@@ -1,6 +0,0 @@
1
- /// <reference types="node" resolution-mode="require"/>
2
- export { v4 as uuidv4 } from "uuid";
3
- export declare const saveJSON: (filename: string, dataset: Record<string, unknown>) => Promise<void>;
4
- export declare const loadJSON: <T = Record<string, unknown>>(filename: string) => Promise<T | null>;
5
- export declare const loadFile: (filename: string) => Promise<string | null>;
6
- export declare const saveFile: (filename: string, dataset: string | Buffer) => Promise<void>;
@@ -1,7 +0,0 @@
1
- export interface BaseSessionWrapper {
2
- [key: string]: unknown;
3
- storageId: string;
4
- appId: string;
5
- sessionId: string;
6
- userId: string;
7
- }
@@ -1,8 +0,0 @@
1
- export { getAvatarToken, getAvatarTokenWithClientSecret, } from "./modules/auth.js";
2
- export { OpenAIClient } from "./modules/openai.js";
3
- export { Store } from "./modules/store.js";
4
- export { UI } from "./modules/ui.js";
5
- export { Tools } from "./modules/tools.js";
6
- export { SermasApp } from "./modules/sermas.js";
7
- export type { OpenAIConfig } from "./modules/openai.js";
8
- export type { SermasConfig } from "./modules/sermas.js";
@@ -1,30 +0,0 @@
1
- export type AuthConfig = {
2
- PUBLIC_AUTH_URL?: string;
3
- PUBLIC_AUTH_REALM?: string;
4
- PRIVATE_AUTH_CLIENT_ID?: string;
5
- PRIVATE_AUTH_CLIENT_SECRET?: string;
6
- PRIVATE_API_BASE_URL?: string;
7
- };
8
- /**
9
- * Returns access and refresh tokens for the given appId
10
- * @param {string} appId null by default
11
- * @param {AuthConfig} authConfig
12
- */
13
- export declare const getAvatarToken: (appId?: string | null, authConfig?: AuthConfig) => Promise<{
14
- appId: string | null;
15
- accessToken?: string | undefined;
16
- refreshToken?: string | undefined;
17
- expiresIn?: Date | undefined;
18
- }>;
19
- /**
20
- * Returns access and refresh tokens for the given appId
21
- * @param {string} appId null by default
22
- * @param {AuthConfig} authConfig only PRIVATE_API_BASE_URL and PRIVATE_AUTH_CLIENT_ID are used
23
- * @param {string} clientSecret needed for server2server authentication
24
- */
25
- export declare const getAvatarTokenWithClientSecret: (appId?: string | null, authConfig?: AuthConfig, clientSecret?: string) => Promise<{
26
- appId: string | null;
27
- accessToken?: string | undefined;
28
- refreshToken?: string | undefined;
29
- expiresIn?: Date | undefined;
30
- }>;
@@ -1,18 +0,0 @@
1
- import OpenAI, { ClientOptions } from "openai";
2
- export type OpenAIConfig = {
3
- apiKey: string;
4
- } & ClientOptions;
5
- type ChatCompletionMessage = {
6
- messages: Array<OpenAI.Chat.ChatCompletionMessageParam>;
7
- };
8
- /**
9
- * Wrapper for OpenAI client to implement sermas functionalities
10
- */
11
- declare class OpenAIClient {
12
- private logger;
13
- private openAI;
14
- constructor(openAIConfig: OpenAIConfig);
15
- chat(body: string | ChatCompletionMessage, options?: OpenAI.RequestOptions<unknown>): Promise<string | null>;
16
- json<T = Record<string, unknown>>(body: string | OpenAI.Chat.ChatCompletionCreateParams, options?: OpenAI.RequestOptions<unknown>): Promise<T | null | undefined>;
17
- }
18
- export { OpenAIClient };
@@ -1,36 +0,0 @@
1
- import { EventEmitter2 } from "eventemitter2";
2
- import { AppToolsDTO, DialogueMessageDto, DialogueToolsRepositoryOptionsDto, PlatformAppDto, SessionDto, SessionStorageRecordDto, SessionStorageSearchDto, UIContentDto } from "@sermas/api-client";
3
- export type SermasConfig = {
4
- SERMAS_BASE_URL: string;
5
- SERMAS_CLIENT_ID: string;
6
- SERMAS_CLIENT_SECRET: string;
7
- SERMAS_APPID: string;
8
- };
9
- declare class SermasApp {
10
- private logger;
11
- private baseUrl;
12
- private app;
13
- private client;
14
- private clientId;
15
- private clientSecret;
16
- private appId;
17
- emitter: EventEmitter2;
18
- subs: (() => void)[];
19
- constructor(sermasConfig: SermasConfig);
20
- getBaseUrl(): string;
21
- initialize(): Promise<void>;
22
- private setupSermasClient;
23
- addSub(sub: () => Promise<() => void>): void;
24
- sendChatMessage(ev: DialogueMessageDto): Promise<void>;
25
- sendUiContent(ev: UIContentDto): Promise<void>;
26
- getApp(): Promise<PlatformAppDto | null>;
27
- updateAppTools(tools: AppToolsDTO[]): Promise<void>;
28
- setTools(repositoryId: string, tools: AppToolsDTO[]): Promise<void>;
29
- addTools(repositoryId: string, tools: AppToolsDTO[], options?: DialogueToolsRepositoryOptionsDto): Promise<void>;
30
- readSession(sessionId: string): Promise<SessionDto | null>;
31
- getRecord(storageId: string): Promise<SessionStorageRecordDto | null>;
32
- findRecords(query: SessionStorageSearchDto): Promise<SessionStorageRecordDto[] | null>;
33
- setRecord(storage: SessionStorageRecordDto): Promise<SessionStorageRecordDto | null>;
34
- generateQRCode(data: string): Promise<any>;
35
- }
36
- export { SermasApp };
@@ -1,21 +0,0 @@
1
- import { SessionChangedDto } from "@sermas/api-client";
2
- import { SermasApp } from "./sermas.js";
3
- import { BaseSessionWrapper } from "../dto/session.js";
4
- declare class Store {
5
- private readonly logger;
6
- private sermas;
7
- private sessions;
8
- private locks;
9
- constructor(sermas: SermasApp);
10
- onSessionChange(ev: SessionChangedDto): Promise<void>;
11
- private lock;
12
- loadSessionWrapper<SessionWrapper extends BaseSessionWrapper>(context: {
13
- sessionId: string;
14
- appId?: string;
15
- userId?: string;
16
- }): Promise<SessionWrapper>;
17
- saveSession<SessionWrapper extends BaseSessionWrapper>(session: SessionWrapper): Promise<SessionWrapper | null>;
18
- getSessionWrapper(sessionId: string): Promise<BaseSessionWrapper | undefined>;
19
- saveSessionWrapper(ev: SessionChangedDto): Promise<unknown>;
20
- }
21
- export { Store };
@@ -1,15 +0,0 @@
1
- import { AppToolsDTO, DialogueToolsRepositoryOptionsDto } from "@sermas/api-client";
2
- import { BaseSessionWrapper } from "../dto/session.js";
3
- import { SermasApp } from "./sermas.js";
4
- type ToolsSchemaValues = string | number | boolean | undefined;
5
- type ToolsSchemaParameters = Record<string, ToolsSchemaValues>;
6
- declare class Tools {
7
- private sermas;
8
- constructor(sermasApp: SermasApp);
9
- reset(session: BaseSessionWrapper): Promise<void>;
10
- set(session: BaseSessionWrapper, tools: AppToolsDTO[]): Promise<void>;
11
- add(session: BaseSessionWrapper, tools: AppToolsDTO[], options?: DialogueToolsRepositoryOptionsDto): Promise<void>;
12
- getSchemaValues<T extends ToolsSchemaParameters = ToolsSchemaParameters>(tool: AppToolsDTO): T;
13
- getSchemaValue(tool: AppToolsDTO, parameterName: string): ToolsSchemaValues;
14
- }
15
- export { Tools };
@@ -1,24 +0,0 @@
1
- import { ButtonDto, SessionChangedDto, UIContentOptionsDto } from "@sermas/api-client";
2
- import { BaseSessionWrapper } from "../dto/session.js";
3
- import { SermasApp } from "./sermas.js";
4
- import { Store } from "./store.js";
5
- declare class UI {
6
- private sermas;
7
- private store;
8
- private readonly logger;
9
- private backMenuOptions;
10
- constructor(sermas: SermasApp, store: Store);
11
- onSessionChange(ev: SessionChangedDto): Promise<void>;
12
- createBackButton(value: string): ButtonDto;
13
- sendBackMenu(session: BaseSessionWrapper, labels: string | string[]): Promise<void>;
14
- sendMenuButtons(session: BaseSessionWrapper, buttons: ButtonDto[]): Promise<void>;
15
- sendAgentMessage(session: BaseSessionWrapper, message: string, messageLanguage: string): Promise<void>;
16
- sendButtons(session: BaseSessionWrapper, label: string, list: (string | ButtonDto)[], metadata?: {
17
- [key: string]: unknown;
18
- }, options?: UIContentOptionsDto): Promise<void>;
19
- sendClearScreen<T extends BaseSessionWrapper>(session: T): Promise<void>;
20
- sendImage(session: BaseSessionWrapper, data: string, width: number, height: number): Promise<void>;
21
- getChunkId(ts?: Date): string;
22
- matchBackMenu(selection: string): boolean | "";
23
- }
24
- export { UI };