@nevermined-io/payments 0.6.0 → 0.7.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/dist/api/nvm-backend.d.ts +15 -5
- package/dist/api/nvm-backend.d.ts.map +1 -1
- package/dist/api/nvm-backend.js +57 -42
- package/dist/api/nvm-backend.js.map +1 -1
- package/dist/api/query-api.d.ts +27 -1
- package/dist/api/query-api.d.ts.map +1 -1
- package/dist/api/query-api.js +30 -14
- package/dist/api/query-api.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { AgentExecutionStatus } from '../common/types';
|
|
2
|
+
import { TaskLogMessage } from './query-api';
|
|
2
3
|
export interface BackendApiOptions {
|
|
3
4
|
/**
|
|
4
5
|
* The host of the backend server
|
|
@@ -31,13 +32,19 @@ export interface BackendApiOptions {
|
|
|
31
32
|
}
|
|
32
33
|
export interface BackendWebSocketOptions {
|
|
33
34
|
/**
|
|
34
|
-
* The
|
|
35
|
+
* The websocket transports to use
|
|
35
36
|
*/
|
|
36
|
-
|
|
37
|
+
transports: string[];
|
|
37
38
|
/**
|
|
38
|
-
*
|
|
39
|
+
* Authentication parameters
|
|
39
40
|
*/
|
|
40
|
-
|
|
41
|
+
auth: {
|
|
42
|
+
token: string;
|
|
43
|
+
};
|
|
44
|
+
/**
|
|
45
|
+
* The path to connect to the websocket server
|
|
46
|
+
*/
|
|
47
|
+
path?: string;
|
|
41
48
|
/**
|
|
42
49
|
* The bearer token to use in the websocket connection
|
|
43
50
|
*/
|
|
@@ -75,12 +82,15 @@ export declare class NVMBackendApi {
|
|
|
75
82
|
private hasKey;
|
|
76
83
|
private _defaultSocketOptions;
|
|
77
84
|
constructor(opts: BackendApiOptions);
|
|
78
|
-
private
|
|
85
|
+
private _connectInternalSocketClient;
|
|
86
|
+
protected connectSocketSubscriber(_callback: (err?: any) => any, opts: SubscriptionOptions): Promise<void>;
|
|
87
|
+
protected connectTasksSocket(_callback: (err?: any) => any, tasks: string[]): Promise<void>;
|
|
79
88
|
private disconnectSocket;
|
|
80
89
|
isWebSocketConnected(): any;
|
|
81
90
|
protected _subscribe(_callback: (err?: any) => any, opts: SubscriptionOptions): Promise<void>;
|
|
82
91
|
private eventHandler;
|
|
83
92
|
protected _emitStepEvents(status?: AgentExecutionStatus, dids?: string[]): Promise<void>;
|
|
93
|
+
protected _emitTaskLog(logMessage: TaskLogMessage): Promise<void>;
|
|
84
94
|
disconnect(): void;
|
|
85
95
|
parseUrl(uri: string, reqOptions: HTTPRequestOptions): string;
|
|
86
96
|
parseHeaders(additionalHeaders: {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"nvm-backend.d.ts","sourceRoot":"","sources":["../../src/api/nvm-backend.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"nvm-backend.d.ts","sourceRoot":"","sources":["../../src/api/nvm-backend.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AAGtD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAE5C,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IAEnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,uBAAuB,CAAA;CAC3C;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE,CAAA;IAEpB;;OAEG;IACH,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAA;CAC1C;AAED,qBAAa,kBAAkB;IAC7B,gBAAgB,EAAE,OAAO,CAAO;IAChC,SAAS,CAAC,EAAE,MAAM,CAAY;IAC9B,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAK;CACzC;AAED,qBAAa,mBAAmB;IAC9B,eAAe,EAAE,OAAO,CAAO;IAC/B,cAAc,EAAE,MAAM,EAAE,CAAK;IAC7B,mBAAmB,EAAE,MAAM,EAAE,CAAmB;IAChD,2BAA2B,EAAE,OAAO,CAAO;CAC5C;AAED,eAAO,MAAM,0BAA0B;;;;;CAKtC,CAAA;AAED,qBAAa,aAAa;IACxB,OAAO,CAAC,IAAI,CAAmB;IAC/B,OAAO,CAAC,YAAY,CAAK;IACzB,OAAO,CAAC,UAAU,CAAgC;IAClD,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,qBAAqB,CAS5B;gBAEW,IAAI,EAAE,iBAAiB;YAsDrB,4BAA4B;cAoB1B,uBAAuB,CACrC,SAAS,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,GAAG,EAC7B,IAAI,EAAE,mBAAmB;cAgBX,kBAAkB,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE;IAwBjF,OAAO,CAAC,gBAAgB;IAMjB,oBAAoB;cAKX,UAAU,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,GAAG,EAAE,IAAI,EAAE,mBAAmB;YAiBrE,YAAY;cAIV,eAAe,CAC7B,MAAM,GAAE,oBAAmD,EAC3D,IAAI,GAAE,MAAM,EAAO;cASL,YAAY,CAAC,UAAU,EAAE,cAAc;IAIvD,UAAU;IAKV,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB;IAUpD,YAAY,CAAC,iBAAiB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE;;;IAOzD,cAAc,CAAC,KAAK,EAAE,MAAM;IAOtB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,GAAE,kBAA+C;;;;;IAU5E,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,kBAAkB;;;;;IAW3D,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,kBAAkB;;;;;IAW1D,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,kBAAkB;;;;;CAUpE"}
|
package/dist/api/nvm-backend.js
CHANGED
|
@@ -5,11 +5,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
6
|
exports.NVMBackendApi = exports.DefaultSubscriptionOptions = exports.SubscriptionOptions = exports.HTTPRequestOptions = void 0;
|
|
7
7
|
const axios_1 = __importDefault(require("axios"));
|
|
8
|
-
const socket_io_client_1 = require("socket.io-client");
|
|
9
8
|
const jose_1 = require("jose");
|
|
9
|
+
const socket_io_client_1 = require("socket.io-client");
|
|
10
|
+
const helper_1 = require("../common/helper");
|
|
10
11
|
const types_1 = require("../common/types");
|
|
11
12
|
const utils_1 = require("../utils");
|
|
12
|
-
const
|
|
13
|
+
const payments_error_1 = require("../common/payments.error");
|
|
13
14
|
class HTTPRequestOptions {
|
|
14
15
|
constructor() {
|
|
15
16
|
this.sendThroughProxy = true;
|
|
@@ -40,11 +41,12 @@ class NVMBackendApi {
|
|
|
40
41
|
this._defaultSocketOptions = {
|
|
41
42
|
// path: '',
|
|
42
43
|
transports: ['websocket'],
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
},
|
|
44
|
+
auth: { token: '' },
|
|
45
|
+
// transportOptions: {
|
|
46
|
+
// websocket: {
|
|
47
|
+
// extraHeaders: {},
|
|
48
|
+
// },
|
|
49
|
+
// },
|
|
48
50
|
};
|
|
49
51
|
const defaultHeaders = {
|
|
50
52
|
Accept: 'application/json',
|
|
@@ -54,23 +56,17 @@ class NVMBackendApi {
|
|
|
54
56
|
if (opts.webSocketOptions?.bearerToken) {
|
|
55
57
|
// If the user pass a specific websocketoptions bearer token we use that one
|
|
56
58
|
opts.webSocketOptions = {
|
|
59
|
+
...this._defaultSocketOptions,
|
|
57
60
|
...opts.webSocketOptions,
|
|
58
|
-
|
|
59
|
-
websocket: {
|
|
60
|
-
extraHeaders: { Authorization: `Bearer ${opts.webSocketOptions.bearerToken}` },
|
|
61
|
-
},
|
|
62
|
-
},
|
|
61
|
+
auth: { token: `Bearer ${opts.webSocketOptions.bearerToken}` },
|
|
63
62
|
};
|
|
64
63
|
}
|
|
65
64
|
else if (opts.apiKey) {
|
|
66
65
|
// If not use the api key
|
|
67
66
|
opts.webSocketOptions = {
|
|
67
|
+
...this._defaultSocketOptions,
|
|
68
68
|
...opts.webSocketOptions,
|
|
69
|
-
|
|
70
|
-
websocket: {
|
|
71
|
-
extraHeaders: { Authorization: `Bearer ${opts.apiKey}` },
|
|
72
|
-
},
|
|
73
|
-
},
|
|
69
|
+
auth: { token: `Bearer ${opts.apiKey}` },
|
|
74
70
|
};
|
|
75
71
|
}
|
|
76
72
|
this.opts = {
|
|
@@ -84,7 +80,6 @@ class NVMBackendApi {
|
|
|
84
80
|
try {
|
|
85
81
|
if (this.opts.apiKey && this.opts.apiKey.length > 0) {
|
|
86
82
|
const jwt = (0, jose_1.decodeJwt)(this.opts.apiKey);
|
|
87
|
-
// if (jwt.sub && !jwt.sub.match(/^0x[a-fA-F0-9]{40}$/)) {
|
|
88
83
|
if ((0, utils_1.isEthereumAddress)(jwt.sub)) {
|
|
89
84
|
this.userRoomId = `room:${jwt.sub}`;
|
|
90
85
|
this.hasKey = true;
|
|
@@ -104,29 +99,53 @@ class NVMBackendApi {
|
|
|
104
99
|
throw new Error(`Invalid URL: ${this.opts.backendHost} - ${error.message}`);
|
|
105
100
|
}
|
|
106
101
|
}
|
|
107
|
-
async
|
|
102
|
+
async _connectInternalSocketClient() {
|
|
108
103
|
if (!this.hasKey)
|
|
109
104
|
throw new Error('Unable to subscribe to the server becase a key was not provided');
|
|
110
|
-
if (this.
|
|
111
|
-
//
|
|
105
|
+
if (this.isWebSocketConnected()) {
|
|
106
|
+
// `_connectInternalSocketClient:: Already connected to the websocket server with id ${this.socketClient.id}`,
|
|
112
107
|
return;
|
|
113
108
|
}
|
|
109
|
+
this.socketClient = (0, socket_io_client_1.io)(this.opts.webSocketHost, this.opts.webSocketOptions);
|
|
110
|
+
await this.socketClient.connect();
|
|
111
|
+
for (let i = 0; i < 10; i++) {
|
|
112
|
+
if (this.isWebSocketConnected())
|
|
113
|
+
return;
|
|
114
|
+
await (0, helper_1.sleep)(500);
|
|
115
|
+
}
|
|
116
|
+
if (!this.isWebSocketConnected()) {
|
|
117
|
+
throw new Error('Unable to connect to the websocket server');
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
async connectSocketSubscriber(_callback, opts) {
|
|
114
121
|
try {
|
|
115
122
|
// nvm-backend:: Connecting to websocket server: ${this.opts.webSocketHost}
|
|
116
|
-
this.
|
|
117
|
-
await this.socketClient.
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
123
|
+
this._connectInternalSocketClient();
|
|
124
|
+
await this.socketClient.on('_connected', async () => {
|
|
125
|
+
this._subscribe(_callback, opts);
|
|
126
|
+
});
|
|
127
|
+
}
|
|
128
|
+
catch (error) {
|
|
129
|
+
throw new payments_error_1.PaymentsError(`Unable to initialize websocket client: ${this.opts.webSocketHost} - ${error.message}`);
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
async connectTasksSocket(_callback, tasks) {
|
|
133
|
+
try {
|
|
134
|
+
if (tasks.length === 0) {
|
|
135
|
+
throw new Error('No task rooms to join in configuration');
|
|
126
136
|
}
|
|
137
|
+
this._connectInternalSocketClient();
|
|
138
|
+
// `connectTasksSocket:: Is connected? ${this.isWebSocketConnected()}`
|
|
139
|
+
await this.socketClient.on('_connected', async () => {
|
|
140
|
+
// `connectTasksSocket:: Joining tasks: ${JSON.stringify(tasks)}`
|
|
141
|
+
await this.socketClient.emit('_join-tasks', JSON.stringify({ tasks }));
|
|
142
|
+
await this.socketClient.on('task-log', (data) => {
|
|
143
|
+
_callback(data);
|
|
144
|
+
});
|
|
145
|
+
});
|
|
127
146
|
}
|
|
128
147
|
catch (error) {
|
|
129
|
-
throw new
|
|
148
|
+
throw new payments_error_1.PaymentsError(`Unable to initialize websocket client: ${this.opts.webSocketHost} - ${error.message}`);
|
|
130
149
|
}
|
|
131
150
|
}
|
|
132
151
|
disconnectSocket() {
|
|
@@ -143,33 +162,29 @@ class NVMBackendApi {
|
|
|
143
162
|
if (!opts.joinAccountRoom && opts.joinAgentRooms.length === 0) {
|
|
144
163
|
throw new Error('No rooms to join in configuration');
|
|
145
164
|
}
|
|
146
|
-
await this.connectSocket();
|
|
147
|
-
// await this.socketClient.emit('subscribe-agent', '')
|
|
148
|
-
await this.socketClient.on('connect', async () => {
|
|
149
|
-
// nvm-backend:: On:: ${this.socketClient.id} Connected to the server
|
|
150
|
-
});
|
|
151
165
|
await this.socketClient.emit('_join-rooms', JSON.stringify(opts));
|
|
152
|
-
// await this.socketClient.on('task-updated', (data: any) => {
|
|
153
|
-
// console.log(`RECEIVED TASK data: ${JSON.stringify(data)}`)
|
|
154
|
-
// _callback(data)
|
|
155
|
-
// })
|
|
156
166
|
opts.subscribeEventTypes.forEach(async (eventType) => {
|
|
157
167
|
await this.socketClient.on(eventType, (data) => {
|
|
158
168
|
_callback(data);
|
|
159
169
|
});
|
|
160
170
|
});
|
|
171
|
+
if (opts.getPendingEventsOnSubscribe) {
|
|
172
|
+
await this._emitStepEvents(types_1.AgentExecutionStatus.Pending, opts.joinAgentRooms);
|
|
173
|
+
}
|
|
161
174
|
}
|
|
162
175
|
async eventHandler(data, _callback, _opts) {
|
|
163
176
|
_callback(data);
|
|
164
177
|
}
|
|
165
178
|
async _emitStepEvents(status = types_1.AgentExecutionStatus.Pending, dids = []) {
|
|
166
|
-
await this.connectSocket();
|
|
167
179
|
const message = {
|
|
168
180
|
status,
|
|
169
181
|
dids,
|
|
170
182
|
};
|
|
171
183
|
this.socketClient.emit('_emit-steps', JSON.stringify(message));
|
|
172
184
|
}
|
|
185
|
+
async _emitTaskLog(logMessage) {
|
|
186
|
+
this.socketClient.emit('_task-log', JSON.stringify(logMessage));
|
|
187
|
+
}
|
|
173
188
|
disconnect() {
|
|
174
189
|
this.disconnectSocket();
|
|
175
190
|
// nvm-backend:: Disconnected from the server
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"nvm-backend.js","sourceRoot":"","sources":["../../src/api/nvm-backend.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAyB;AACzB,uDAAqC;AACrC
|
|
1
|
+
{"version":3,"file":"nvm-backend.js","sourceRoot":"","sources":["../../src/api/nvm-backend.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAyB;AACzB,+BAAgC;AAChC,uDAAqC;AACrC,6CAAwC;AACxC,2CAAsD;AACtD,oCAA4C;AAC5C,6DAAwD;AAgExD,MAAa,kBAAkB;IAA/B;QACE,qBAAgB,GAAY,IAAI,CAAA;QAChC,cAAS,GAAY,SAAS,CAAA;QAC9B,YAAO,GAA+B,EAAE,CAAA;IAC1C,CAAC;CAAA;AAJD,gDAIC;AAED,MAAa,mBAAmB;IAAhC;QACE,oBAAe,GAAY,IAAI,CAAA;QAC/B,mBAAc,GAAa,EAAE,CAAA;QAC7B,wBAAmB,GAAa,CAAC,cAAc,CAAC,CAAA;QAChD,gCAA2B,GAAY,IAAI,CAAA;IAC7C,CAAC;CAAA;AALD,kDAKC;AAEY,QAAA,0BAA0B,GAAG;IACxC,eAAe,EAAE,IAAI;IACrB,cAAc,EAAE,EAAE;IAClB,mBAAmB,EAAE,CAAC,cAAc,CAAC;IACrC,2BAA2B,EAAE,IAAI;CAClC,CAAA;AAED,MAAa,aAAa;IAgBxB,YAAY,IAAuB;QAb3B,eAAU,GAAuB,SAAS,CAAA;QAC1C,WAAM,GAAG,KAAK,CAAA;QACd,0BAAqB,GAA4B;YACvD,YAAY;YACZ,UAAU,EAAE,CAAC,WAAW,CAAC;YACzB,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;YACnB,sBAAsB;YACtB,iBAAiB;YACjB,wBAAwB;YACxB,OAAO;YACP,KAAK;SACN,CAAA;QAGC,MAAM,cAAc,GAAG;YACrB,MAAM,EAAE,kBAAkB;YAC1B,GAAG,IAAI,CAAC,OAAO;YACf,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;SAC/D,CAAA;QAED,IAAI,IAAI,CAAC,gBAAgB,EAAE,WAAW,EAAE,CAAC;YACvC,4EAA4E;YAC5E,IAAI,CAAC,gBAAgB,GAAG;gBACtB,GAAG,IAAI,CAAC,qBAAqB;gBAC7B,GAAG,IAAI,CAAC,gBAAgB;gBACxB,IAAI,EAAE,EAAE,KAAK,EAAE,UAAU,IAAI,CAAC,gBAAiB,CAAC,WAAW,EAAE,EAAE;aAChE,CAAA;QACH,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACvB,yBAAyB;YACzB,IAAI,CAAC,gBAAgB,GAAG;gBACtB,GAAG,IAAI,CAAC,qBAAqB;gBAC7B,GAAG,IAAI,CAAC,gBAAgB;gBACxB,IAAI,EAAE,EAAE,KAAK,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE,EAAE;aACzC,CAAA;QACH,CAAC;QAED,IAAI,CAAC,IAAI,GAAG;YACV,GAAG,IAAI;YACP,gBAAgB,EAAE;gBAChB,GAAG,IAAI,CAAC,qBAAqB;gBAC7B,GAAG,IAAI,CAAC,gBAAgB;aACzB;YACD,OAAO,EAAE,cAAc;SACxB,CAAA;QAED,IAAI,CAAC;YACH,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACpD,MAAM,GAAG,GAAG,IAAA,gBAAS,EAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBACvC,IAAI,IAAA,yBAAiB,EAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC/B,IAAI,CAAC,UAAU,GAAG,QAAQ,GAAG,CAAC,GAAG,EAAE,CAAA;oBACnC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAA;gBACpB,CAAC;YACH,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;YACnB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAA;QAC7B,CAAC;QAED,IAAI,UAAU,CAAA;QACd,IAAI,CAAC;YACH,UAAU,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;YAC3C,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,MAAM,CAAA;QAC3C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC,WAAW,MAAO,KAAe,CAAC,OAAO,EAAE,CAAC,CAAA;QACxF,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,4BAA4B;QACxC,IAAI,CAAC,IAAI,CAAC,MAAM;YACd,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAA;QAEpF,IAAI,IAAI,CAAC,oBAAoB,EAAE,EAAE,CAAC;YAChC,gHAAgH;YAChH,OAAM;QACR,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,IAAA,qBAAE,EAAC,IAAI,CAAC,IAAI,CAAC,aAAc,EAAE,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAC5E,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAA;QACjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,oBAAoB,EAAE;gBAAE,OAAM;YACvC,MAAM,IAAA,cAAK,EAAC,GAAG,CAAC,CAAA;QAClB,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;QAC9D,CAAC;IACH,CAAC;IAES,KAAK,CAAC,uBAAuB,CACrC,SAA6B,EAC7B,IAAyB;QAEzB,IAAI,CAAC;YACH,2EAA2E;YAC3E,IAAI,CAAC,4BAA4B,EAAE,CAAA;YAEnC,MAAM,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,EAAE,KAAK,IAAI,EAAE;gBAClD,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;YAClC,CAAC,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,8BAAa,CACrB,0CAA0C,IAAI,CAAC,IAAI,CAAC,aAAa,MAAO,KAAe,CAAC,OAAO,EAAE,CAClG,CAAA;QACH,CAAC;IACH,CAAC;IAES,KAAK,CAAC,kBAAkB,CAAC,SAA6B,EAAE,KAAe;QAC/E,IAAI,CAAC;YACH,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACvB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;YAC3D,CAAC;YAED,IAAI,CAAC,4BAA4B,EAAE,CAAA;YAEnC,sEAAsE;YAEtE,MAAM,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,EAAE,KAAK,IAAI,EAAE;gBAClD,iEAAiE;gBACjE,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;gBACtE,MAAM,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,IAAS,EAAE,EAAE;oBACnD,SAAS,CAAC,IAAI,CAAC,CAAA;gBACjB,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,8BAAa,CACrB,0CAA0C,IAAI,CAAC,IAAI,CAAC,aAAa,MAAO,KAAe,CAAC,OAAO,EAAE,CAClG,CAAA;QACH,CAAC;IACH,CAAC;IAEO,gBAAgB;QACtB,IAAI,IAAI,CAAC,oBAAoB,EAAE,EAAE,CAAC;YAChC,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAA;QAChC,CAAC;IACH,CAAC;IAEM,oBAAoB;QACzB,IAAI,IAAI,CAAC,YAAY;YAAE,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,CAAA;QACzD,OAAO,KAAK,CAAA;IACd,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,SAA6B,EAAE,IAAyB;QACjF,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9D,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;QACtD,CAAC;QAED,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;QAEjE,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;YACnD,MAAM,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,IAAS,EAAE,EAAE;gBAClD,SAAS,CAAC,IAAI,CAAC,CAAA;YACjB,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QACF,IAAI,IAAI,CAAC,2BAA2B,EAAE,CAAC;YACrC,MAAM,IAAI,CAAC,eAAe,CAAC,4BAAoB,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAA;QAC/E,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,IAAS,EAAE,SAA6B,EAAE,KAA0B;QAC7F,SAAS,CAAC,IAAI,CAAC,CAAA;IACjB,CAAC;IAES,KAAK,CAAC,eAAe,CAC7B,SAA+B,4BAAoB,CAAC,OAAO,EAC3D,OAAiB,EAAE;QAEnB,MAAM,OAAO,GAAG;YACd,MAAM;YACN,IAAI;SACL,CAAA;QACD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;IAChE,CAAC;IAES,KAAK,CAAC,YAAY,CAAC,UAA0B;QACrD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAA;IACjE,CAAC;IAED,UAAU;QACR,IAAI,CAAC,gBAAgB,EAAE,CAAA;QACvB,6CAA6C;IAC/C,CAAC;IAED,QAAQ,CAAC,GAAW,EAAE,UAA8B;QAClD,IAAI,KAAU,CAAA;QACd,IAAI,UAAU,CAAC,gBAAgB,EAAE,CAAC;YAChC,IAAI,UAAU,CAAC,SAAS;gBAAE,KAAK,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAA;iBAC1D,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS;gBAAE,KAAK,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;;gBAC7D,KAAK,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QAC7C,CAAC;;YAAM,KAAK,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QAC7C,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,GAAG,EAAE,CAAA;IAChC,CAAC;IAED,YAAY,CAAC,iBAA4C;QACvD,OAAO;YACL,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO;YACpB,GAAG,iBAAiB;SACrB,CAAA;IACH,CAAC;IAED,cAAc,CAAC,KAAa;QAC1B,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG;YAClB,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO;YACpB,aAAa,EAAE,UAAU,KAAK,EAAE;SACjC,CAAA;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,aAAiC,EAAE,gBAAgB,EAAE,IAAI,EAAE;QAChF,OAAO,IAAA,eAAK,EAAC;YACX,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC;YACnC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,OAAO,IAAI,EAAE,CAAC;SACrD,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACf,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAA;QAChG,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,GAAW,EAAE,IAAS,EAAE,UAA8B;QAC/D,OAAO,IAAA,eAAK,EAAC;YACX,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC;YACnC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,OAAO,IAAI,EAAE,CAAC;YACpD,IAAI,EAAE,IAAI;SACX,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACf,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAA;QAChG,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,IAAS,EAAE,UAA8B;QAC9D,OAAO,IAAA,eAAK,EAAC;YACX,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC;YACnC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,OAAO,IAAI,EAAE,CAAC;YACpD,IAAI,EAAE,IAAI;SACX,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACf,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAA;QAChG,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE,IAAS,EAAE,UAA8B;QACjE,OAAO,IAAA,eAAK,EAAC;YACX,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC;YACnC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,OAAO,IAAI,EAAE,CAAC;YACpD,IAAI,EAAE,IAAI;SACX,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACf,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAA;QAChG,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AA1PD,sCA0PC"}
|
package/dist/api/query-api.d.ts
CHANGED
|
@@ -26,6 +26,13 @@ export interface SearchSteps {
|
|
|
26
26
|
page?: number;
|
|
27
27
|
offset?: number;
|
|
28
28
|
}
|
|
29
|
+
export interface TaskLogMessage {
|
|
30
|
+
level: 'info' | 'error' | 'warning' | 'debug';
|
|
31
|
+
task_id: string;
|
|
32
|
+
task_status: AgentExecutionStatus;
|
|
33
|
+
message: string;
|
|
34
|
+
step_id?: string;
|
|
35
|
+
}
|
|
29
36
|
/**
|
|
30
37
|
* Options required for interacting with an external AI Agent/Service.
|
|
31
38
|
*/
|
|
@@ -59,6 +66,16 @@ export declare class AIQueryApi extends NVMBackendApi {
|
|
|
59
66
|
* @param opts - The subscription options
|
|
60
67
|
*/
|
|
61
68
|
subscribe(_callback: (err?: any) => any, opts?: SubscriptionOptions): Promise<void>;
|
|
69
|
+
/**
|
|
70
|
+
* It subscribes to receive the logs generated during the execution of a task/s
|
|
71
|
+
*
|
|
72
|
+
* @remarks
|
|
73
|
+
* This method is used by users/subscribers of AI agents after they create a task on them
|
|
74
|
+
*
|
|
75
|
+
* @param _callback - The callback to execute when a new task log event is received
|
|
76
|
+
* @param tasks - The list of tasks to subscribe to
|
|
77
|
+
*/
|
|
78
|
+
subscribeTasksLogs(_callback: (err?: any) => any, tasks: string[]): Promise<void>;
|
|
62
79
|
/**
|
|
63
80
|
* Subscribers can create an AI Task for an Agent. The task must contain the input query that will be used by the AI Agent.
|
|
64
81
|
* @see https://docs.nevermined.io/docs/protocol/query-protocol
|
|
@@ -94,9 +111,10 @@ export declare class AIQueryApi extends NVMBackendApi {
|
|
|
94
111
|
* @param did - Agent DID
|
|
95
112
|
* @param task - Task object. The task object should contain the query to execute and the name of the task. All the attributes here: @see https://docs.nevermined.io/docs/protocol/query-protocol#tasks-attributes
|
|
96
113
|
* @param queryOpts - The query options @see {@link Payments.getServiceAccessConfig}
|
|
114
|
+
* @param _callback - The callback to execute when a new task log event is received (optional)
|
|
97
115
|
* @returns The result of the operation
|
|
98
116
|
*/
|
|
99
|
-
createTask(did: string, task: any, queryOpts: AIQueryOptions): Promise<import("axios").AxiosResponse<any, any> | {
|
|
117
|
+
createTask(did: string, task: any, queryOpts: AIQueryOptions, _callback?: (err?: any) => any): Promise<import("axios").AxiosResponse<any, any> | {
|
|
100
118
|
data: any;
|
|
101
119
|
status: any;
|
|
102
120
|
headers: any;
|
|
@@ -274,5 +292,13 @@ export declare class AIQueryApi extends NVMBackendApi {
|
|
|
274
292
|
status: any;
|
|
275
293
|
headers: any;
|
|
276
294
|
}>;
|
|
295
|
+
/**
|
|
296
|
+
* It emits a log message related to a task
|
|
297
|
+
*
|
|
298
|
+
* @remarks
|
|
299
|
+
* This method is used by the AI Agent to emit log messages
|
|
300
|
+
*
|
|
301
|
+
*/
|
|
302
|
+
logTask(logMessage: TaskLogMessage): Promise<void>;
|
|
277
303
|
}
|
|
278
304
|
//# sourceMappingURL=query-api.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"query-api.d.ts","sourceRoot":"","sources":["../../src/api/query-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAE5D,OAAO,EACL,iBAAiB,EAGjB,aAAa,EACb,mBAAmB,EACpB,MAAM,eAAe,CAAA;AAEtB,eAAO,MAAM,qBAAqB,gCAAgC,CAAA;AAClE,eAAO,MAAM,qBAAqB,gCAAgC,CAAA;AAClE,eAAO,MAAM,qBAAqB,8CAA8C,CAAA;AAChF,eAAO,MAAM,oBAAoB,sDAAsD,CAAA;AACvF,eAAO,MAAM,mBAAmB,mBAAmB,CAAA;AACnD,eAAO,MAAM,0BAA0B,yBAAyB,CAAA;AAChE,eAAO,MAAM,uBAAuB,8CAA8C,CAAA;AAClF,eAAO,MAAM,aAAa,+BAA+B,CAAA;AACzD,eAAO,MAAM,iBAAiB,wCAAwC,CAAA;AAEtE,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,oBAAoB,CAAA;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,oBAAoB,CAAA;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,qBAAa,cAAc;IACzB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;;;;;GAMG;AACH,qBAAa,UAAW,SAAQ,aAAa;gBAC/B,IAAI,EAAE,iBAAiB;IAInC;;;;;;;;OAQG;IACG,SAAS,CACb,SAAS,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,GAAG,EAC7B,IAAI,GAAE,mBAAgD;
|
|
1
|
+
{"version":3,"file":"query-api.d.ts","sourceRoot":"","sources":["../../src/api/query-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAE5D,OAAO,EACL,iBAAiB,EAGjB,aAAa,EACb,mBAAmB,EACpB,MAAM,eAAe,CAAA;AAEtB,eAAO,MAAM,qBAAqB,gCAAgC,CAAA;AAClE,eAAO,MAAM,qBAAqB,gCAAgC,CAAA;AAClE,eAAO,MAAM,qBAAqB,8CAA8C,CAAA;AAChF,eAAO,MAAM,oBAAoB,sDAAsD,CAAA;AACvF,eAAO,MAAM,mBAAmB,mBAAmB,CAAA;AACnD,eAAO,MAAM,0BAA0B,yBAAyB,CAAA;AAChE,eAAO,MAAM,uBAAuB,8CAA8C,CAAA;AAClF,eAAO,MAAM,aAAa,+BAA+B,CAAA;AACzD,eAAO,MAAM,iBAAiB,wCAAwC,CAAA;AAEtE,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,oBAAoB,CAAA;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,oBAAoB,CAAA;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,OAAO,CAAA;IAC7C,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,oBAAoB,CAAA;IACjC,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,qBAAa,cAAc;IACzB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;;;;;GAMG;AACH,qBAAa,UAAW,SAAQ,aAAa;gBAC/B,IAAI,EAAE,iBAAiB;IAInC;;;;;;;;OAQG;IACG,SAAS,CACb,SAAS,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,GAAG,EAC7B,IAAI,GAAE,mBAAgD;IAKxD;;;;;;;;OAQG;IACG,kBAAkB,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE;IAIvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACG,UAAU,CACd,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,GAAG,EACT,SAAS,EAAE,cAAc,EACzB,SAAS,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,GAAG;;;;;IAiBhC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc;;;;;IAW7E;;;;;;;;;;OAUG;IACG,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;;;;;IAKzD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI;;;;;IAkBxC;;;;;;;;;;;;;OAaG;IACG,WAAW,CAAC,YAAY,EAAE,WAAW;;;;;IAI3C;;;;;;;;;;;;;OAaG;IACG,WAAW,CAAC,YAAY,EAAE,WAAW;;;;;IAI3C;;;;;;;;;;;;;OAaG;IACG,OAAO,CAAC,MAAM,EAAE,MAAM;IAW5B;;;;;;;;;;OAUG;IACG,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;;;;;IAMnE;;;;;;;;;OASG;IACG,QAAQ,CACZ,MAAM,GAAE,oBAAoB,GAAG,SAAwC,EACvE,IAAI,GAAE,MAAM,EAAO;;;;;IAQrB;;;;;;;OAOG;IACG,kBAAkB;;;;;IAIxB;;;;;;OAMG;IACG,OAAO,CAAC,UAAU,EAAE,cAAc;CAGzC"}
|
package/dist/api/query-api.js
CHANGED
|
@@ -40,18 +40,19 @@ class AIQueryApi extends nvm_backend_1.NVMBackendApi {
|
|
|
40
40
|
* @param opts - The subscription options
|
|
41
41
|
*/
|
|
42
42
|
async subscribe(_callback, opts = nvm_backend_1.DefaultSubscriptionOptions) {
|
|
43
|
-
await super.
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
43
|
+
await super.connectSocketSubscriber(_callback, opts);
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* It subscribes to receive the logs generated during the execution of a task/s
|
|
47
|
+
*
|
|
48
|
+
* @remarks
|
|
49
|
+
* This method is used by users/subscribers of AI agents after they create a task on them
|
|
50
|
+
*
|
|
51
|
+
* @param _callback - The callback to execute when a new task log event is received
|
|
52
|
+
* @param tasks - The list of tasks to subscribe to
|
|
53
|
+
*/
|
|
54
|
+
async subscribeTasksLogs(_callback, tasks) {
|
|
55
|
+
await super.connectTasksSocket(_callback, tasks);
|
|
55
56
|
}
|
|
56
57
|
/**
|
|
57
58
|
* Subscribers can create an AI Task for an Agent. The task must contain the input query that will be used by the AI Agent.
|
|
@@ -88,9 +89,10 @@ class AIQueryApi extends nvm_backend_1.NVMBackendApi {
|
|
|
88
89
|
* @param did - Agent DID
|
|
89
90
|
* @param task - Task object. The task object should contain the query to execute and the name of the task. All the attributes here: @see https://docs.nevermined.io/docs/protocol/query-protocol#tasks-attributes
|
|
90
91
|
* @param queryOpts - The query options @see {@link Payments.getServiceAccessConfig}
|
|
92
|
+
* @param _callback - The callback to execute when a new task log event is received (optional)
|
|
91
93
|
* @returns The result of the operation
|
|
92
94
|
*/
|
|
93
|
-
async createTask(did, task, queryOpts) {
|
|
95
|
+
async createTask(did, task, queryOpts, _callback) {
|
|
94
96
|
const endpoint = exports.TASK_ENDPOINT.replace('{did}', did);
|
|
95
97
|
const reqOptions = {
|
|
96
98
|
sendThroughProxy: true,
|
|
@@ -99,7 +101,11 @@ class AIQueryApi extends nvm_backend_1.NVMBackendApi {
|
|
|
99
101
|
headers: { Authorization: `Bearer ${queryOpts.accessToken}` },
|
|
100
102
|
}),
|
|
101
103
|
};
|
|
102
|
-
|
|
104
|
+
const result = await this.post(endpoint, task, reqOptions);
|
|
105
|
+
if (result.status === 201 && _callback) {
|
|
106
|
+
await this.subscribeTasksLogs(_callback, [result.data.task.task_id]);
|
|
107
|
+
}
|
|
108
|
+
return result;
|
|
103
109
|
}
|
|
104
110
|
/**
|
|
105
111
|
* It returns the full task and the steps resulted of the execution of the task.
|
|
@@ -294,6 +300,16 @@ class AIQueryApi extends nvm_backend_1.NVMBackendApi {
|
|
|
294
300
|
async getTasksFromAgents() {
|
|
295
301
|
return this.get(exports.GET_AGENTS_ENDPOINT, { sendThroughProxy: false });
|
|
296
302
|
}
|
|
303
|
+
/**
|
|
304
|
+
* It emits a log message related to a task
|
|
305
|
+
*
|
|
306
|
+
* @remarks
|
|
307
|
+
* This method is used by the AI Agent to emit log messages
|
|
308
|
+
*
|
|
309
|
+
*/
|
|
310
|
+
async logTask(logMessage) {
|
|
311
|
+
super._emitTaskLog(logMessage);
|
|
312
|
+
}
|
|
297
313
|
}
|
|
298
314
|
exports.AIQueryApi = AIQueryApi;
|
|
299
315
|
//# sourceMappingURL=query-api.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"query-api.js","sourceRoot":"","sources":["../../src/api/query-api.ts"],"names":[],"mappings":";;;AAAA,2CAA4D;AAC5D,oCAAwC;AACxC,+CAMsB;AAET,QAAA,qBAAqB,GAAG,6BAA6B,CAAA;AACrD,QAAA,qBAAqB,GAAG,6BAA6B,CAAA;AACrD,QAAA,qBAAqB,GAAG,2CAA2C,CAAA;AACnE,QAAA,oBAAoB,GAAG,mDAAmD,CAAA;AAC1E,QAAA,mBAAmB,GAAG,gBAAgB,CAAA;AACtC,QAAA,0BAA0B,GAAG,sBAAsB,CAAA;AACnD,QAAA,uBAAuB,GAAG,2CAA2C,CAAA;AACrE,QAAA,aAAa,GAAG,4BAA4B,CAAA;AAC5C,QAAA,iBAAiB,GAAG,qCAAqC,CAAA;
|
|
1
|
+
{"version":3,"file":"query-api.js","sourceRoot":"","sources":["../../src/api/query-api.ts"],"names":[],"mappings":";;;AAAA,2CAA4D;AAC5D,oCAAwC;AACxC,+CAMsB;AAET,QAAA,qBAAqB,GAAG,6BAA6B,CAAA;AACrD,QAAA,qBAAqB,GAAG,6BAA6B,CAAA;AACrD,QAAA,qBAAqB,GAAG,2CAA2C,CAAA;AACnE,QAAA,oBAAoB,GAAG,mDAAmD,CAAA;AAC1E,QAAA,mBAAmB,GAAG,gBAAgB,CAAA;AACtC,QAAA,0BAA0B,GAAG,sBAAsB,CAAA;AACnD,QAAA,uBAAuB,GAAG,2CAA2C,CAAA;AACrE,QAAA,aAAa,GAAG,4BAA4B,CAAA;AAC5C,QAAA,iBAAiB,GAAG,qCAAqC,CAAA;AA6BtE;;GAEG;AACH,MAAa,cAAc;CAW1B;AAXD,wCAWC;AAED;;;;;;GAMG;AACH,MAAa,UAAW,SAAQ,2BAAa;IAC3C,YAAY,IAAuB;QACjC,KAAK,CAAC,IAAI,CAAC,CAAA;IACb,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,SAAS,CACb,SAA6B,EAC7B,OAA4B,wCAA0B;QAEtD,MAAM,KAAK,CAAC,uBAAuB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;IACtD,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,kBAAkB,CAAC,SAA6B,EAAE,KAAe;QACrE,MAAM,KAAK,CAAC,kBAAkB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;IAClD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,KAAK,CAAC,UAAU,CACd,GAAW,EACX,IAAS,EACT,SAAyB,EACzB,SAA8B;QAE9B,MAAM,QAAQ,GAAG,qBAAa,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;QACpD,MAAM,UAAU,GAAuB;YACrC,gBAAgB,EAAE,IAAI;YACtB,GAAG,CAAC,SAAS,CAAC,kBAAkB,IAAI,EAAE,SAAS,EAAE,SAAS,CAAC,kBAAkB,EAAE,CAAC;YAChF,GAAG,CAAC,SAAS,CAAC,WAAW,IAAI;gBAC3B,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,SAAS,CAAC,WAAW,EAAE,EAAE;aAC9D,CAAC;SACH,CAAA;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,UAAU,CAAC,CAAA;QAC1D,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,IAAI,SAAS,EAAE,CAAC;YACvC,MAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;QACtE,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,gBAAgB,CAAC,GAAW,EAAE,MAAc,EAAE,SAAyB;QAC3E,MAAM,UAAU,GAAuB;YACrC,gBAAgB,EAAE,IAAI;YACtB,GAAG,CAAC,SAAS,CAAC,kBAAkB,IAAI,EAAE,SAAS,EAAE,SAAS,CAAC,kBAAkB,EAAE,CAAC;YAChF,GAAG,CAAC,SAAS,CAAC,WAAW,IAAI;gBAC3B,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,SAAS,CAAC,WAAW,EAAE,EAAE;aAC9D,CAAC;SACH,CAAA;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAiB,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE,UAAU,CAAC,CAAA;IAClG,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,WAAW,CAAC,GAAW,EAAE,MAAc,EAAE,KAAU;QACvD,MAAM,QAAQ,GAAG,6BAAqB,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;QACxF,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,CAAA;IAChE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,UAAU,CAAC,GAAW,EAAE,IAAU;QACtC,IAAI,CAAC;YACH,OAAQ,IAAyB,CAAC,GAAG,CAAA;QACvC,CAAC;QAAC,MAAM,CAAC;YACP,6BAA6B;QAC/B,CAAC;QAED,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;QACjD,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM;YACpB,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAA;QAEpF,MAAM,QAAQ,GAAG,4BAAoB,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;aACxD,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC;aAC3B,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;QAE9B,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,CAAA;IAC9D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,WAAW,CAAC,YAAyB;QACzC,OAAO,IAAI,CAAC,IAAI,CAAC,6BAAqB,EAAE,YAAY,EAAE,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,CAAA;IACpF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,WAAW,CAAC,YAAyB;QACzC,OAAO,IAAI,CAAC,IAAI,CAAC,6BAAqB,EAAE,YAAY,EAAE,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,CAAA;IACpF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,OAAO,CAAC,MAAc;QAC1B,IAAI,CAAC,IAAA,qBAAa,EAAC,MAAM,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;QAE9D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAA;QAE1D,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9F,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAC7B,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,gBAAgB,MAAM,YAAY,CAAC,CAAA;IACrD,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,gBAAgB,CAAC,GAAW,EAAE,MAAc,EAAE,MAAe;QACjE,IAAI,QAAQ,GAAG,+BAAuB,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAA;QACxF,IAAI,MAAM;YAAE,QAAQ,IAAI,WAAW,MAAM,EAAE,CAAA;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,CAAA;IACxD,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,QAAQ,CACZ,SAA2C,4BAAoB,CAAC,OAAO,EACvE,OAAiB,EAAE;QAEnB,IAAI,QAAQ,GAAG,kCAA0B,GAAG,GAAG,CAAA;QAC/C,IAAI,MAAM;YAAE,QAAQ,IAAI,WAAW,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAA;QACtD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;YAAE,QAAQ,IAAI,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;QAC1D,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,CAAA;IACxD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,kBAAkB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,2BAAmB,EAAE,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,CAAA;IACnE,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CAAC,UAA0B;QACtC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;IAChC,CAAC;CACF;AApTD,gCAoTC"}
|