vovk 3.2.1 → 3.4.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/HttpException.d.ts +7 -0
- package/dist/HttpException.js +15 -0
- package/dist/JSONLinesResponse.d.ts +14 -0
- package/dist/JSONLinesResponse.js +59 -0
- package/dist/VovkApp.d.ts +29 -0
- package/dist/VovkApp.js +189 -0
- package/dist/client/index.d.ts +3 -0
- package/dist/client/index.js +7 -0
- package/dist/client/types.d.ts +102 -0
- package/dist/client/types.js +2 -0
- package/dist/createDecorator.d.ts +6 -0
- package/dist/createDecorator.js +43 -0
- package/dist/createVovkApp.d.ts +62 -0
- package/dist/createVovkApp.js +129 -0
- package/dist/internal.d.ts +1 -1
- package/dist/internal.js +1 -0
- package/dist/tools/createTool.d.ts +32 -32
- package/dist/tools/createToolFactory.d.ts +33 -33
- package/dist/tools/deriveTools.d.ts +5 -5
- package/dist/tools/deriveTools.js +5 -6
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/types/standard-tool.d.ts +17 -0
- package/dist/types/standard-tool.js +1 -0
- package/dist/types/tools.d.ts +20 -16
- package/dist/types.d.ts +239 -0
- package/dist/types.js +66 -0
- package/dist/utils/generateStaticAPI.d.ts +4 -0
- package/dist/utils/generateStaticAPI.js +30 -0
- package/dist/utils/getSchema.d.ts +20 -0
- package/dist/utils/getSchema.js +33 -0
- package/dist/utils/parseQuery.d.ts +25 -0
- package/dist/utils/parseQuery.js +156 -0
- package/dist/utils/reqForm.d.ts +2 -0
- package/dist/utils/reqForm.js +32 -0
- package/dist/utils/reqMeta.d.ts +2 -0
- package/dist/utils/reqMeta.js +13 -0
- package/dist/utils/reqQuery.d.ts +2 -0
- package/dist/utils/reqQuery.js +10 -0
- package/dist/utils/serializeQuery.d.ts +13 -0
- package/dist/utils/serializeQuery.js +65 -0
- package/dist/utils/setHandlerSchema.d.ts +4 -0
- package/dist/utils/setHandlerSchema.js +15 -0
- package/dist/utils/withValidation.d.ts +21 -0
- package/dist/utils/withValidation.js +88 -0
- package/dist/validation/createStandardValidation.d.ts +32 -32
- package/dist/validation/procedure.d.ts +32 -32
- package/dist/validation/validationSchemasObjectToSingleValidationSchema.d.ts +17 -0
- package/dist/validation/validationSchemasObjectToSingleValidationSchema.js +92 -0
- package/package.json +1 -1
- package/dist/core/compose.d.ts +0 -38
- package/dist/core/compose.js +0 -31
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.createVovkApp = createVovkApp;
|
|
7
|
+
const VovkApp_1 = require("./VovkApp");
|
|
8
|
+
const types_1 = require("./types");
|
|
9
|
+
const getSchema_1 = __importDefault(require("./utils/getSchema"));
|
|
10
|
+
const trimPath = (path) => path.trim().replace(/^\/|\/$/g, '');
|
|
11
|
+
const isClass = (func) => typeof func === 'function' && /class/.test(func.toString());
|
|
12
|
+
const toKebabCase = (str) => str
|
|
13
|
+
.replace(/([a-z0-9])([A-Z])/g, '$1-$2') // Add hyphen between lowercase/digit and uppercase
|
|
14
|
+
.replace(/([A-Z])([A-Z])(?=[a-z])/g, '$1-$2') // Add hyphen between uppercase letters if the second one is followed by a lowercase
|
|
15
|
+
.toLowerCase()
|
|
16
|
+
.replace(/^-/, ''); // Remove leading hyphen
|
|
17
|
+
const assignSchema = ({ controller, propertyKey, path, options, httpMethod, vovkApp, }) => {
|
|
18
|
+
if (typeof window !== 'undefined') {
|
|
19
|
+
throw new Error('Decorators are intended for server-side use only. You have probably imported a controller on the client-side.');
|
|
20
|
+
}
|
|
21
|
+
if (!isClass(controller)) {
|
|
22
|
+
let decoratorName = httpMethod.toLowerCase();
|
|
23
|
+
if (decoratorName === 'delete')
|
|
24
|
+
decoratorName = 'del';
|
|
25
|
+
throw new Error(`Decorator must be used on a static class method. Check the controller method named "${propertyKey}" used with @${decoratorName}().`);
|
|
26
|
+
}
|
|
27
|
+
const methods = vovkApp.routes[httpMethod].get(controller) ?? {};
|
|
28
|
+
vovkApp.routes[httpMethod].set(controller, methods);
|
|
29
|
+
const originalMethod = controller[propertyKey];
|
|
30
|
+
originalMethod._controller = controller;
|
|
31
|
+
originalMethod._sourceMethod = originalMethod._sourceMethod ?? originalMethod;
|
|
32
|
+
const schema = originalMethod._sourceMethod._getSchema?.(controller);
|
|
33
|
+
controller._handlers = {
|
|
34
|
+
...controller._handlers,
|
|
35
|
+
[propertyKey]: {
|
|
36
|
+
...schema,
|
|
37
|
+
...(controller._handlers ?? {})[propertyKey],
|
|
38
|
+
path,
|
|
39
|
+
httpMethod,
|
|
40
|
+
},
|
|
41
|
+
};
|
|
42
|
+
methods[path] = controller[propertyKey];
|
|
43
|
+
methods[path]._options = options;
|
|
44
|
+
controller._handlersMetadata = {
|
|
45
|
+
...controller._handlersMetadata,
|
|
46
|
+
[propertyKey]: {
|
|
47
|
+
...(controller._handlersMetadata ?? {})[propertyKey],
|
|
48
|
+
staticParams: options?.staticParams,
|
|
49
|
+
},
|
|
50
|
+
};
|
|
51
|
+
};
|
|
52
|
+
function createVovkApp() {
|
|
53
|
+
const vovkApp = new VovkApp_1.VovkApp();
|
|
54
|
+
const createHTTPDecorator = (httpMethod) => {
|
|
55
|
+
function decoratorCreator(givenPath = '', options) {
|
|
56
|
+
const path = trimPath(givenPath);
|
|
57
|
+
function decorator(givenTarget, propertyKey) {
|
|
58
|
+
const controller = givenTarget;
|
|
59
|
+
assignSchema({ controller, propertyKey, path, options, httpMethod, vovkApp });
|
|
60
|
+
}
|
|
61
|
+
return decorator;
|
|
62
|
+
}
|
|
63
|
+
const auto = (options) => {
|
|
64
|
+
function decorator(givenTarget, propertyKey) {
|
|
65
|
+
const controller = givenTarget;
|
|
66
|
+
const methods = vovkApp.routes[httpMethod].get(controller) ?? {};
|
|
67
|
+
vovkApp.routes[httpMethod].set(controller, methods);
|
|
68
|
+
controller._handlers = {
|
|
69
|
+
...controller._handlers,
|
|
70
|
+
[propertyKey]: {
|
|
71
|
+
...(controller._handlers ?? {})[propertyKey],
|
|
72
|
+
httpMethod,
|
|
73
|
+
},
|
|
74
|
+
};
|
|
75
|
+
const properties = Object.keys(controller._handlers[propertyKey]?.validation?.params?.properties ?? {});
|
|
76
|
+
const kebab = toKebabCase(propertyKey); // 🥙
|
|
77
|
+
const path = properties.length ? `${kebab}/${properties.map((prop) => `:${prop}`).join('/')}` : kebab;
|
|
78
|
+
assignSchema({ controller, propertyKey, path, options, httpMethod, vovkApp });
|
|
79
|
+
}
|
|
80
|
+
return decorator;
|
|
81
|
+
};
|
|
82
|
+
const enhancedDecoratorCreator = decoratorCreator;
|
|
83
|
+
enhancedDecoratorCreator.auto = auto;
|
|
84
|
+
return enhancedDecoratorCreator;
|
|
85
|
+
};
|
|
86
|
+
const prefix = (givenPath = '') => {
|
|
87
|
+
const path = trimPath(givenPath);
|
|
88
|
+
return (givenTarget) => {
|
|
89
|
+
const controller = givenTarget;
|
|
90
|
+
controller._prefix = path;
|
|
91
|
+
return givenTarget;
|
|
92
|
+
};
|
|
93
|
+
};
|
|
94
|
+
const initVovk = (options) => {
|
|
95
|
+
for (const [rpcModuleName, controller] of Object.entries(options.controllers)) {
|
|
96
|
+
controller._rpcModuleName = rpcModuleName;
|
|
97
|
+
controller._activated = true;
|
|
98
|
+
controller._onError = options?.onError;
|
|
99
|
+
}
|
|
100
|
+
async function GET_DEV(req, data) {
|
|
101
|
+
const params = await data.params;
|
|
102
|
+
if (params[Object.keys(params)[0]]?.[0] === '_schema_') {
|
|
103
|
+
const schema = (0, getSchema_1.default)(options);
|
|
104
|
+
return vovkApp.respond(200, { schema });
|
|
105
|
+
}
|
|
106
|
+
return vovkApp.GET(req, data);
|
|
107
|
+
}
|
|
108
|
+
return {
|
|
109
|
+
GET: process.env.NODE_ENV === 'development' ? GET_DEV : vovkApp.GET,
|
|
110
|
+
POST: vovkApp.POST,
|
|
111
|
+
PUT: vovkApp.PUT,
|
|
112
|
+
PATCH: vovkApp.PATCH,
|
|
113
|
+
DELETE: vovkApp.DELETE,
|
|
114
|
+
HEAD: vovkApp.HEAD,
|
|
115
|
+
OPTIONS: vovkApp.OPTIONS,
|
|
116
|
+
};
|
|
117
|
+
};
|
|
118
|
+
return {
|
|
119
|
+
get: createHTTPDecorator(types_1.HttpMethod.GET),
|
|
120
|
+
post: createHTTPDecorator(types_1.HttpMethod.POST),
|
|
121
|
+
put: createHTTPDecorator(types_1.HttpMethod.PUT),
|
|
122
|
+
patch: createHTTPDecorator(types_1.HttpMethod.PATCH),
|
|
123
|
+
del: createHTTPDecorator(types_1.HttpMethod.DELETE),
|
|
124
|
+
head: createHTTPDecorator(types_1.HttpMethod.HEAD),
|
|
125
|
+
options: createHTTPDecorator(types_1.HttpMethod.OPTIONS),
|
|
126
|
+
prefix,
|
|
127
|
+
initVovk,
|
|
128
|
+
};
|
|
129
|
+
}
|
package/dist/internal.d.ts
CHANGED
|
@@ -2,12 +2,12 @@ export { deepExtend } from './utils/deepExtend.js';
|
|
|
2
2
|
export { resolveGeneratorConfigValues } from './core/resolveGeneratorConfigValues.js';
|
|
3
3
|
export { createCodeSamples } from './samples/createCodeSamples.js';
|
|
4
4
|
export { withValidationLibrary } from './validation/withValidationLibrary.js';
|
|
5
|
+
export { validationSchemasObjectToSingleValidationSchema } from './validation/validationSchemasObjectToSingleValidationSchema.js';
|
|
5
6
|
export { operation } from './openapi/operation.js';
|
|
6
7
|
export { openAPIToVovkSchema } from './openapi/openAPIToVovkSchema/index.js';
|
|
7
8
|
export { vovkSchemaToOpenAPI } from './openapi/vovkSchemaToOpenAPI.js';
|
|
8
9
|
export { readableStreamToAsyncIterable } from './client/defaultStreamHandler.js';
|
|
9
10
|
export { VovkSchemaIdEnum } from './types/enums.js';
|
|
10
|
-
export type { VovkToolDerived, VovkToolNonDerived } from './types/tools.js';
|
|
11
11
|
export type { MCPModelOutput } from './tools/toModelOutputMCP.js';
|
|
12
12
|
export type { VovkErrorResponse, VovkMetaSchema, VovkSegmentSchema, VovkControllerSchema, VovkHandlerSchema, VovkValidationType, } from './types/core.js';
|
|
13
13
|
export type { VovkTypedProcedure } from './types/validation.js';
|
package/dist/internal.js
CHANGED
|
@@ -3,6 +3,7 @@ export { deepExtend } from './utils/deepExtend.js';
|
|
|
3
3
|
export { resolveGeneratorConfigValues } from './core/resolveGeneratorConfigValues.js';
|
|
4
4
|
export { createCodeSamples } from './samples/createCodeSamples.js';
|
|
5
5
|
export { withValidationLibrary } from './validation/withValidationLibrary.js';
|
|
6
|
+
export { validationSchemasObjectToSingleValidationSchema } from './validation/validationSchemasObjectToSingleValidationSchema.js';
|
|
6
7
|
export { operation } from './openapi/operation.js';
|
|
7
8
|
export { openAPIToVovkSchema } from './openapi/openAPIToVovkSchema/index.js';
|
|
8
9
|
export { vovkSchemaToOpenAPI } from './openapi/vovkSchemaToOpenAPI.js';
|
|
@@ -7,120 +7,120 @@ export declare const createTool: {
|
|
|
7
7
|
name: string;
|
|
8
8
|
title?: string;
|
|
9
9
|
description: string;
|
|
10
|
-
onExecute?: ((result: unknown, tool: import("../
|
|
11
|
-
onError?: ((error: Error, tool: import("../
|
|
10
|
+
onExecute?: ((result: unknown, tool: import("../index.js").VovkTool<TInput, TOutput, TToModelOutput extends import("./toModelOutputDefault.js").ToModelOutputDefaultFn ? import("./toModelOutputDefault.js").DefaultModelOutput<TOutput> : TToModelOutput extends (...args: import("../types/utils.js").KnownAny[]) => infer R ? R extends Promise<infer U> ? U : R : unknown>) => void) | undefined;
|
|
11
|
+
onError?: ((error: Error, tool: import("../index.js").VovkTool<TInput, TOutput, TToModelOutput extends import("./toModelOutputDefault.js").ToModelOutputDefaultFn ? import("./toModelOutputDefault.js").DefaultModelOutput<TOutput> : TToModelOutput extends (...args: import("../types/utils.js").KnownAny[]) => infer R ? R extends Promise<infer U> ? U : R : unknown>) => void) | undefined;
|
|
12
12
|
target?: import("../types/validation.js").CombinedSpec.Target;
|
|
13
13
|
} & {
|
|
14
14
|
inputSchema: import("../types/validation.js").CombinedSpec<TInput, TInput>;
|
|
15
15
|
} & {
|
|
16
16
|
outputSchema: import("../types/validation.js").CombinedSpec<TOutput, TOutput>;
|
|
17
17
|
} & {
|
|
18
|
-
execute: (input: TInput, processingMeta?:
|
|
18
|
+
execute: (input: TInput, processingMeta?: import("../types/utils.js").KnownAny) => TOutput | Promise<TOutput>;
|
|
19
19
|
toModelOutput: TToModelOutput;
|
|
20
|
-
}): import("../
|
|
20
|
+
}): import("../index.js").VovkTool<TInput, TOutput, TToModelOutput extends import("./toModelOutputDefault.js").ToModelOutputDefaultFn ? import("./toModelOutputDefault.js").DefaultModelOutput<TOutput> : TToModelOutput extends (...args: import("../types/utils.js").KnownAny[]) => infer R ? R extends Promise<infer U> ? U : R : unknown>;
|
|
21
21
|
<TInput, TOutput>(options: {
|
|
22
22
|
name: string;
|
|
23
23
|
title?: string;
|
|
24
24
|
description: string;
|
|
25
|
-
onExecute?: ((result: unknown, tool: import("../
|
|
26
|
-
onError?: ((error: Error, tool: import("../
|
|
25
|
+
onExecute?: ((result: unknown, tool: import("../index.js").VovkTool<TInput, TOutput, import("./toModelOutputDefault.js").DefaultModelOutput<TOutput>>) => void) | undefined;
|
|
26
|
+
onError?: ((error: Error, tool: import("../index.js").VovkTool<TInput, TOutput, import("./toModelOutputDefault.js").DefaultModelOutput<TOutput>>) => void) | undefined;
|
|
27
27
|
target?: import("../types/validation.js").CombinedSpec.Target;
|
|
28
28
|
} & {
|
|
29
29
|
inputSchema: import("../types/validation.js").CombinedSpec<TInput, TInput>;
|
|
30
30
|
} & {
|
|
31
31
|
outputSchema: import("../types/validation.js").CombinedSpec<TOutput, TOutput>;
|
|
32
32
|
} & {
|
|
33
|
-
execute: (input: TInput, processingMeta?:
|
|
33
|
+
execute: (input: TInput, processingMeta?: import("../types/utils.js").KnownAny) => TOutput | Promise<TOutput>;
|
|
34
34
|
toModelOutput?: undefined;
|
|
35
|
-
}): import("../
|
|
35
|
+
}): import("../index.js").VovkTool<TInput, TOutput, import("./toModelOutputDefault.js").DefaultModelOutput<TOutput>>;
|
|
36
36
|
<TInput, TOutput, TToModelOutput extends (...args: import("../types/utils.js").KnownAny[]) => import("../types/utils.js").KnownAny>(options: {
|
|
37
37
|
name: string;
|
|
38
38
|
title?: string;
|
|
39
39
|
description: string;
|
|
40
|
-
onExecute?: ((result: unknown, tool: import("../
|
|
41
|
-
onError?: ((error: Error, tool: import("../
|
|
40
|
+
onExecute?: ((result: unknown, tool: import("../index.js").VovkTool<TInput, TOutput, TToModelOutput extends import("./toModelOutputDefault.js").ToModelOutputDefaultFn ? import("./toModelOutputDefault.js").DefaultModelOutput<TOutput> : TToModelOutput extends (...args: import("../types/utils.js").KnownAny[]) => infer R ? R extends Promise<infer U> ? U : R : unknown>) => void) | undefined;
|
|
41
|
+
onError?: ((error: Error, tool: import("../index.js").VovkTool<TInput, TOutput, TToModelOutput extends import("./toModelOutputDefault.js").ToModelOutputDefaultFn ? import("./toModelOutputDefault.js").DefaultModelOutput<TOutput> : TToModelOutput extends (...args: import("../types/utils.js").KnownAny[]) => infer R ? R extends Promise<infer U> ? U : R : unknown>) => void) | undefined;
|
|
42
42
|
target?: import("../types/validation.js").CombinedSpec.Target;
|
|
43
43
|
} & {
|
|
44
44
|
inputSchema: import("../types/validation.js").CombinedSpec<TInput, TInput>;
|
|
45
45
|
} & {
|
|
46
46
|
outputSchema?: undefined;
|
|
47
47
|
} & {
|
|
48
|
-
execute: (input: TInput, processingMeta?:
|
|
48
|
+
execute: (input: TInput, processingMeta?: import("../types/utils.js").KnownAny) => TOutput | Promise<TOutput>;
|
|
49
49
|
toModelOutput: TToModelOutput;
|
|
50
|
-
}): import("../
|
|
50
|
+
}): import("../index.js").VovkTool<TInput, TOutput, TToModelOutput extends import("./toModelOutputDefault.js").ToModelOutputDefaultFn ? import("./toModelOutputDefault.js").DefaultModelOutput<TOutput> : TToModelOutput extends (...args: import("../types/utils.js").KnownAny[]) => infer R ? R extends Promise<infer U> ? U : R : unknown>;
|
|
51
51
|
<TInput, TOutput>(options: {
|
|
52
52
|
name: string;
|
|
53
53
|
title?: string;
|
|
54
54
|
description: string;
|
|
55
|
-
onExecute?: ((result: unknown, tool: import("../
|
|
56
|
-
onError?: ((error: Error, tool: import("../
|
|
55
|
+
onExecute?: ((result: unknown, tool: import("../index.js").VovkTool<TInput, TOutput, import("./toModelOutputDefault.js").DefaultModelOutput<TOutput>>) => void) | undefined;
|
|
56
|
+
onError?: ((error: Error, tool: import("../index.js").VovkTool<TInput, TOutput, import("./toModelOutputDefault.js").DefaultModelOutput<TOutput>>) => void) | undefined;
|
|
57
57
|
target?: import("../types/validation.js").CombinedSpec.Target;
|
|
58
58
|
} & {
|
|
59
59
|
inputSchema: import("../types/validation.js").CombinedSpec<TInput, TInput>;
|
|
60
60
|
} & {
|
|
61
61
|
outputSchema?: undefined;
|
|
62
62
|
} & {
|
|
63
|
-
execute: (input: TInput, processingMeta?:
|
|
63
|
+
execute: (input: TInput, processingMeta?: import("../types/utils.js").KnownAny) => TOutput | Promise<TOutput>;
|
|
64
64
|
toModelOutput?: undefined;
|
|
65
|
-
}): import("../
|
|
65
|
+
}): import("../index.js").VovkTool<TInput, TOutput, import("./toModelOutputDefault.js").DefaultModelOutput<TOutput>>;
|
|
66
66
|
<TOutput, TToModelOutput extends (...args: import("../types/utils.js").KnownAny[]) => import("../types/utils.js").KnownAny>(options: {
|
|
67
67
|
name: string;
|
|
68
68
|
title?: string;
|
|
69
69
|
description: string;
|
|
70
|
-
onExecute?: ((result: unknown, tool: import("../
|
|
71
|
-
onError?: ((error: Error, tool: import("../
|
|
70
|
+
onExecute?: ((result: unknown, tool: import("../index.js").VovkTool<null, TOutput, TToModelOutput extends import("./toModelOutputDefault.js").ToModelOutputDefaultFn ? import("./toModelOutputDefault.js").DefaultModelOutput<TOutput> : TToModelOutput extends (...args: import("../types/utils.js").KnownAny[]) => infer R ? R extends Promise<infer U> ? U : R : unknown>) => void) | undefined;
|
|
71
|
+
onError?: ((error: Error, tool: import("../index.js").VovkTool<null, TOutput, TToModelOutput extends import("./toModelOutputDefault.js").ToModelOutputDefaultFn ? import("./toModelOutputDefault.js").DefaultModelOutput<TOutput> : TToModelOutput extends (...args: import("../types/utils.js").KnownAny[]) => infer R ? R extends Promise<infer U> ? U : R : unknown>) => void) | undefined;
|
|
72
72
|
target?: import("../types/validation.js").CombinedSpec.Target;
|
|
73
73
|
} & {
|
|
74
74
|
inputSchema?: undefined;
|
|
75
75
|
} & {
|
|
76
76
|
outputSchema: import("../types/validation.js").CombinedSpec<TOutput, TOutput>;
|
|
77
77
|
} & {
|
|
78
|
-
execute: (input: null, processingMeta?:
|
|
78
|
+
execute: (input: null, processingMeta?: import("../types/utils.js").KnownAny) => TOutput | Promise<TOutput>;
|
|
79
79
|
toModelOutput: TToModelOutput;
|
|
80
|
-
}): import("../
|
|
80
|
+
}): import("../index.js").VovkTool<null, TOutput, TToModelOutput extends import("./toModelOutputDefault.js").ToModelOutputDefaultFn ? import("./toModelOutputDefault.js").DefaultModelOutput<TOutput> : TToModelOutput extends (...args: import("../types/utils.js").KnownAny[]) => infer R ? R extends Promise<infer U> ? U : R : unknown>;
|
|
81
81
|
<TOutput>(options: {
|
|
82
82
|
name: string;
|
|
83
83
|
title?: string;
|
|
84
84
|
description: string;
|
|
85
|
-
onExecute?: ((result: unknown, tool: import("../
|
|
86
|
-
onError?: ((error: Error, tool: import("../
|
|
85
|
+
onExecute?: ((result: unknown, tool: import("../index.js").VovkTool<null, TOutput, import("./toModelOutputDefault.js").DefaultModelOutput<TOutput>>) => void) | undefined;
|
|
86
|
+
onError?: ((error: Error, tool: import("../index.js").VovkTool<null, TOutput, import("./toModelOutputDefault.js").DefaultModelOutput<TOutput>>) => void) | undefined;
|
|
87
87
|
target?: import("../types/validation.js").CombinedSpec.Target;
|
|
88
88
|
} & {
|
|
89
89
|
inputSchema?: undefined;
|
|
90
90
|
} & {
|
|
91
91
|
outputSchema: import("../types/validation.js").CombinedSpec<TOutput, TOutput>;
|
|
92
92
|
} & {
|
|
93
|
-
execute: (input: null, processingMeta?:
|
|
93
|
+
execute: (input: null, processingMeta?: import("../types/utils.js").KnownAny) => TOutput | Promise<TOutput>;
|
|
94
94
|
toModelOutput?: undefined;
|
|
95
|
-
}): import("../
|
|
95
|
+
}): import("../index.js").VovkTool<null, TOutput, import("./toModelOutputDefault.js").DefaultModelOutput<TOutput>>;
|
|
96
96
|
<TOutput, TToModelOutput extends (...args: import("../types/utils.js").KnownAny[]) => import("../types/utils.js").KnownAny>(options: {
|
|
97
97
|
name: string;
|
|
98
98
|
title?: string;
|
|
99
99
|
description: string;
|
|
100
|
-
onExecute?: ((result: unknown, tool: import("../
|
|
101
|
-
onError?: ((error: Error, tool: import("../
|
|
100
|
+
onExecute?: ((result: unknown, tool: import("../index.js").VovkTool<null, TOutput, TToModelOutput extends import("./toModelOutputDefault.js").ToModelOutputDefaultFn ? import("./toModelOutputDefault.js").DefaultModelOutput<TOutput> : TToModelOutput extends (...args: import("../types/utils.js").KnownAny[]) => infer R ? R extends Promise<infer U> ? U : R : unknown>) => void) | undefined;
|
|
101
|
+
onError?: ((error: Error, tool: import("../index.js").VovkTool<null, TOutput, TToModelOutput extends import("./toModelOutputDefault.js").ToModelOutputDefaultFn ? import("./toModelOutputDefault.js").DefaultModelOutput<TOutput> : TToModelOutput extends (...args: import("../types/utils.js").KnownAny[]) => infer R ? R extends Promise<infer U> ? U : R : unknown>) => void) | undefined;
|
|
102
102
|
target?: import("../types/validation.js").CombinedSpec.Target;
|
|
103
103
|
} & {
|
|
104
104
|
inputSchema?: undefined;
|
|
105
105
|
} & {
|
|
106
106
|
outputSchema?: undefined;
|
|
107
107
|
} & {
|
|
108
|
-
execute: (input: null, processingMeta?:
|
|
108
|
+
execute: (input: null, processingMeta?: import("../types/utils.js").KnownAny) => TOutput | Promise<TOutput>;
|
|
109
109
|
toModelOutput: TToModelOutput;
|
|
110
|
-
}): import("../
|
|
110
|
+
}): import("../index.js").VovkTool<null, TOutput, TToModelOutput extends import("./toModelOutputDefault.js").ToModelOutputDefaultFn ? import("./toModelOutputDefault.js").DefaultModelOutput<TOutput> : TToModelOutput extends (...args: import("../types/utils.js").KnownAny[]) => infer R ? R extends Promise<infer U> ? U : R : unknown>;
|
|
111
111
|
<TOutput>(options: {
|
|
112
112
|
name: string;
|
|
113
113
|
title?: string;
|
|
114
114
|
description: string;
|
|
115
|
-
onExecute?: ((result: unknown, tool: import("../
|
|
116
|
-
onError?: ((error: Error, tool: import("../
|
|
115
|
+
onExecute?: ((result: unknown, tool: import("../index.js").VovkTool<null, TOutput, import("./toModelOutputDefault.js").DefaultModelOutput<TOutput>>) => void) | undefined;
|
|
116
|
+
onError?: ((error: Error, tool: import("../index.js").VovkTool<null, TOutput, import("./toModelOutputDefault.js").DefaultModelOutput<TOutput>>) => void) | undefined;
|
|
117
117
|
target?: import("../types/validation.js").CombinedSpec.Target;
|
|
118
118
|
} & {
|
|
119
119
|
inputSchema?: undefined;
|
|
120
120
|
} & {
|
|
121
121
|
outputSchema?: undefined;
|
|
122
122
|
} & {
|
|
123
|
-
execute: (input: null, processingMeta?:
|
|
123
|
+
execute: (input: null, processingMeta?: import("../types/utils.js").KnownAny) => TOutput | Promise<TOutput>;
|
|
124
124
|
toModelOutput?: undefined;
|
|
125
|
-
}): import("../
|
|
125
|
+
}): import("../index.js").VovkTool<null, TOutput, import("./toModelOutputDefault.js").DefaultModelOutput<TOutput>>;
|
|
126
126
|
};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { VovkValidationType } from '../types/core.js';
|
|
2
|
-
import type {
|
|
2
|
+
import type { VovkTool } from '../types/tools.js';
|
|
3
3
|
import type { DefaultModelOutput, ToModelOutputDefaultFn } from './toModelOutputDefault.js';
|
|
4
4
|
import type { CombinedSpec } from '../types/validation.js';
|
|
5
5
|
import type { KnownAny } from '../types/utils.js';
|
|
@@ -15,121 +15,121 @@ export declare function createToolFactory({ toJSONSchema, }: {
|
|
|
15
15
|
name: string;
|
|
16
16
|
title?: string;
|
|
17
17
|
description: string;
|
|
18
|
-
onExecute?: ((result: unknown, tool:
|
|
19
|
-
onError?: ((error: Error, tool:
|
|
18
|
+
onExecute?: ((result: unknown, tool: VovkTool<TInput, TOutput, InferFormattedOutput<TToModelOutput, TOutput>>) => void) | undefined;
|
|
19
|
+
onError?: ((error: Error, tool: VovkTool<TInput, TOutput, InferFormattedOutput<TToModelOutput, TOutput>>) => void) | undefined;
|
|
20
20
|
target?: CombinedSpec.Target;
|
|
21
21
|
} & {
|
|
22
22
|
inputSchema: CombinedSpec<TInput, TInput>;
|
|
23
23
|
} & {
|
|
24
24
|
outputSchema: CombinedSpec<TOutput, TOutput>;
|
|
25
25
|
} & {
|
|
26
|
-
execute: (input: TInput, processingMeta?:
|
|
26
|
+
execute: (input: TInput, processingMeta?: KnownAny) => TOutput | Promise<TOutput>;
|
|
27
27
|
toModelOutput: TToModelOutput;
|
|
28
|
-
}):
|
|
28
|
+
}): VovkTool<TInput, TOutput, InferFormattedOutput<TToModelOutput, TOutput>>;
|
|
29
29
|
<TInput, TOutput>(options: {
|
|
30
30
|
name: string;
|
|
31
31
|
title?: string;
|
|
32
32
|
description: string;
|
|
33
|
-
onExecute?: ((result: unknown, tool:
|
|
34
|
-
onError?: ((error: Error, tool:
|
|
33
|
+
onExecute?: ((result: unknown, tool: VovkTool<TInput, TOutput, DefaultModelOutput<TOutput>>) => void) | undefined;
|
|
34
|
+
onError?: ((error: Error, tool: VovkTool<TInput, TOutput, DefaultModelOutput<TOutput>>) => void) | undefined;
|
|
35
35
|
target?: CombinedSpec.Target;
|
|
36
36
|
} & {
|
|
37
37
|
inputSchema: CombinedSpec<TInput, TInput>;
|
|
38
38
|
} & {
|
|
39
39
|
outputSchema: CombinedSpec<TOutput, TOutput>;
|
|
40
40
|
} & {
|
|
41
|
-
execute: (input: TInput, processingMeta?:
|
|
41
|
+
execute: (input: TInput, processingMeta?: KnownAny) => TOutput | Promise<TOutput>;
|
|
42
42
|
toModelOutput?: undefined;
|
|
43
|
-
}):
|
|
43
|
+
}): VovkTool<TInput, TOutput, DefaultModelOutput<TOutput>>;
|
|
44
44
|
<TInput, TOutput, TToModelOutput extends AnyToModelOutputFn>(options: {
|
|
45
45
|
name: string;
|
|
46
46
|
title?: string;
|
|
47
47
|
description: string;
|
|
48
|
-
onExecute?: ((result: unknown, tool:
|
|
49
|
-
onError?: ((error: Error, tool:
|
|
48
|
+
onExecute?: ((result: unknown, tool: VovkTool<TInput, TOutput, InferFormattedOutput<TToModelOutput, TOutput>>) => void) | undefined;
|
|
49
|
+
onError?: ((error: Error, tool: VovkTool<TInput, TOutput, InferFormattedOutput<TToModelOutput, TOutput>>) => void) | undefined;
|
|
50
50
|
target?: CombinedSpec.Target;
|
|
51
51
|
} & {
|
|
52
52
|
inputSchema: CombinedSpec<TInput, TInput>;
|
|
53
53
|
} & {
|
|
54
54
|
outputSchema?: undefined;
|
|
55
55
|
} & {
|
|
56
|
-
execute: (input: TInput, processingMeta?:
|
|
56
|
+
execute: (input: TInput, processingMeta?: KnownAny) => TOutput | Promise<TOutput>;
|
|
57
57
|
toModelOutput: TToModelOutput;
|
|
58
|
-
}):
|
|
58
|
+
}): VovkTool<TInput, TOutput, InferFormattedOutput<TToModelOutput, TOutput>>;
|
|
59
59
|
<TInput, TOutput>(options: {
|
|
60
60
|
name: string;
|
|
61
61
|
title?: string;
|
|
62
62
|
description: string;
|
|
63
|
-
onExecute?: ((result: unknown, tool:
|
|
64
|
-
onError?: ((error: Error, tool:
|
|
63
|
+
onExecute?: ((result: unknown, tool: VovkTool<TInput, TOutput, DefaultModelOutput<TOutput>>) => void) | undefined;
|
|
64
|
+
onError?: ((error: Error, tool: VovkTool<TInput, TOutput, DefaultModelOutput<TOutput>>) => void) | undefined;
|
|
65
65
|
target?: CombinedSpec.Target;
|
|
66
66
|
} & {
|
|
67
67
|
inputSchema: CombinedSpec<TInput, TInput>;
|
|
68
68
|
} & {
|
|
69
69
|
outputSchema?: undefined;
|
|
70
70
|
} & {
|
|
71
|
-
execute: (input: TInput, processingMeta?:
|
|
71
|
+
execute: (input: TInput, processingMeta?: KnownAny) => TOutput | Promise<TOutput>;
|
|
72
72
|
toModelOutput?: undefined;
|
|
73
|
-
}):
|
|
73
|
+
}): VovkTool<TInput, TOutput, DefaultModelOutput<TOutput>>;
|
|
74
74
|
<TOutput, TToModelOutput extends AnyToModelOutputFn>(options: {
|
|
75
75
|
name: string;
|
|
76
76
|
title?: string;
|
|
77
77
|
description: string;
|
|
78
|
-
onExecute?: ((result: unknown, tool:
|
|
79
|
-
onError?: ((error: Error, tool:
|
|
78
|
+
onExecute?: ((result: unknown, tool: VovkTool<null, TOutput, InferFormattedOutput<TToModelOutput, TOutput>>) => void) | undefined;
|
|
79
|
+
onError?: ((error: Error, tool: VovkTool<null, TOutput, InferFormattedOutput<TToModelOutput, TOutput>>) => void) | undefined;
|
|
80
80
|
target?: CombinedSpec.Target;
|
|
81
81
|
} & {
|
|
82
82
|
inputSchema?: undefined;
|
|
83
83
|
} & {
|
|
84
84
|
outputSchema: CombinedSpec<TOutput, TOutput>;
|
|
85
85
|
} & {
|
|
86
|
-
execute: (input: null, processingMeta?:
|
|
86
|
+
execute: (input: null, processingMeta?: KnownAny) => TOutput | Promise<TOutput>;
|
|
87
87
|
toModelOutput: TToModelOutput;
|
|
88
|
-
}):
|
|
88
|
+
}): VovkTool<null, TOutput, InferFormattedOutput<TToModelOutput, TOutput>>;
|
|
89
89
|
<TOutput>(options: {
|
|
90
90
|
name: string;
|
|
91
91
|
title?: string;
|
|
92
92
|
description: string;
|
|
93
|
-
onExecute?: ((result: unknown, tool:
|
|
94
|
-
onError?: ((error: Error, tool:
|
|
93
|
+
onExecute?: ((result: unknown, tool: VovkTool<null, TOutput, DefaultModelOutput<TOutput>>) => void) | undefined;
|
|
94
|
+
onError?: ((error: Error, tool: VovkTool<null, TOutput, DefaultModelOutput<TOutput>>) => void) | undefined;
|
|
95
95
|
target?: CombinedSpec.Target;
|
|
96
96
|
} & {
|
|
97
97
|
inputSchema?: undefined;
|
|
98
98
|
} & {
|
|
99
99
|
outputSchema: CombinedSpec<TOutput, TOutput>;
|
|
100
100
|
} & {
|
|
101
|
-
execute: (input: null, processingMeta?:
|
|
101
|
+
execute: (input: null, processingMeta?: KnownAny) => TOutput | Promise<TOutput>;
|
|
102
102
|
toModelOutput?: undefined;
|
|
103
|
-
}):
|
|
103
|
+
}): VovkTool<null, TOutput, DefaultModelOutput<TOutput>>;
|
|
104
104
|
<TOutput, TToModelOutput extends AnyToModelOutputFn>(options: {
|
|
105
105
|
name: string;
|
|
106
106
|
title?: string;
|
|
107
107
|
description: string;
|
|
108
|
-
onExecute?: ((result: unknown, tool:
|
|
109
|
-
onError?: ((error: Error, tool:
|
|
108
|
+
onExecute?: ((result: unknown, tool: VovkTool<null, TOutput, InferFormattedOutput<TToModelOutput, TOutput>>) => void) | undefined;
|
|
109
|
+
onError?: ((error: Error, tool: VovkTool<null, TOutput, InferFormattedOutput<TToModelOutput, TOutput>>) => void) | undefined;
|
|
110
110
|
target?: CombinedSpec.Target;
|
|
111
111
|
} & {
|
|
112
112
|
inputSchema?: undefined;
|
|
113
113
|
} & {
|
|
114
114
|
outputSchema?: undefined;
|
|
115
115
|
} & {
|
|
116
|
-
execute: (input: null, processingMeta?:
|
|
116
|
+
execute: (input: null, processingMeta?: KnownAny) => TOutput | Promise<TOutput>;
|
|
117
117
|
toModelOutput: TToModelOutput;
|
|
118
|
-
}):
|
|
118
|
+
}): VovkTool<null, TOutput, InferFormattedOutput<TToModelOutput, TOutput>>;
|
|
119
119
|
<TOutput>(options: {
|
|
120
120
|
name: string;
|
|
121
121
|
title?: string;
|
|
122
122
|
description: string;
|
|
123
|
-
onExecute?: ((result: unknown, tool:
|
|
124
|
-
onError?: ((error: Error, tool:
|
|
123
|
+
onExecute?: ((result: unknown, tool: VovkTool<null, TOutput, DefaultModelOutput<TOutput>>) => void) | undefined;
|
|
124
|
+
onError?: ((error: Error, tool: VovkTool<null, TOutput, DefaultModelOutput<TOutput>>) => void) | undefined;
|
|
125
125
|
target?: CombinedSpec.Target;
|
|
126
126
|
} & {
|
|
127
127
|
inputSchema?: undefined;
|
|
128
128
|
} & {
|
|
129
129
|
outputSchema?: undefined;
|
|
130
130
|
} & {
|
|
131
|
-
execute: (input: null, processingMeta?:
|
|
131
|
+
execute: (input: null, processingMeta?: KnownAny) => TOutput | Promise<TOutput>;
|
|
132
132
|
toModelOutput?: undefined;
|
|
133
|
-
}):
|
|
133
|
+
}): VovkTool<null, TOutput, DefaultModelOutput<TOutput>>;
|
|
134
134
|
};
|
|
135
135
|
export {};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { DefaultModelOutput } from './toModelOutputDefault.js';
|
|
2
2
|
import type { VovkRequest } from '../types/request.js';
|
|
3
|
-
import type {
|
|
3
|
+
import type { VovkTool, ToModelOutputFn } from '../types/tools.js';
|
|
4
4
|
type DerivedToolInput = {
|
|
5
5
|
body?: unknown;
|
|
6
6
|
query?: unknown;
|
|
@@ -9,12 +9,12 @@ type DerivedToolInput = {
|
|
|
9
9
|
type DeriveToolsBaseOptions<TOutput = unknown, TFormattedOutput = unknown> = {
|
|
10
10
|
modules: Record<string, object>;
|
|
11
11
|
meta?: Record<string, unknown>;
|
|
12
|
-
onExecute?: (result: unknown, tool:
|
|
13
|
-
onError?: (error: Error, tool:
|
|
12
|
+
onExecute?: (result: unknown, tool: VovkTool<DerivedToolInput, TOutput, TFormattedOutput>, req: Pick<VovkRequest, 'vovk'> | null) => void;
|
|
13
|
+
onError?: (error: Error, tool: VovkTool<DerivedToolInput, TOutput, TFormattedOutput>, req: Pick<VovkRequest, 'vovk'> | null) => void;
|
|
14
14
|
};
|
|
15
15
|
type DeriveToolsResult<TOutput, TFormattedOutput> = {
|
|
16
|
-
tools:
|
|
17
|
-
toolsByName: Record<string,
|
|
16
|
+
tools: VovkTool<DerivedToolInput, TOutput, TFormattedOutput>[];
|
|
17
|
+
toolsByName: Record<string, VovkTool<DerivedToolInput, TOutput, TFormattedOutput>>;
|
|
18
18
|
};
|
|
19
19
|
/**
|
|
20
20
|
* Derives AI tools from controllers and RPC modules.
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { ToModelOutput } from './ToModelOutput.js';
|
|
2
|
+
import { validationSchemasObjectToSingleValidationSchema } from '../validation/validationSchemasObjectToSingleValidationSchema.js';
|
|
2
3
|
async function caller({ handler, handlerName, body, query, params, meta, toModelOutput }, tool) {
|
|
3
4
|
if (!handler.isRPC && !handler.fn) {
|
|
4
5
|
throw new Error('Handler is not a valid RPC or controller method');
|
|
@@ -27,10 +28,7 @@ async function caller({ handler, handlerName, body, query, params, meta, toModel
|
|
|
27
28
|
else {
|
|
28
29
|
throw new Error(`Unable to call handler "${handlerName}". It's neither RPC nor controller method with "fn" interface.`);
|
|
29
30
|
}
|
|
30
|
-
return [
|
|
31
|
-
await toModelOutput(result, tool, req),
|
|
32
|
-
req,
|
|
33
|
-
];
|
|
31
|
+
return [await toModelOutput(result, tool, req), req];
|
|
34
32
|
}
|
|
35
33
|
catch (e) {
|
|
36
34
|
return [await toModelOutput(e, tool, null), null];
|
|
@@ -46,7 +44,8 @@ const makeTool = ({ moduleName, handlerName, module, meta, toModelOutput, onExec
|
|
|
46
44
|
}
|
|
47
45
|
const { schema, definition } = handler;
|
|
48
46
|
const inputSchemas = Object.fromEntries(['body', 'query', 'params'].map((key) => [key, definition?.[key]]).filter(([, value]) => Boolean(value)));
|
|
49
|
-
|
|
47
|
+
const inputSchema = Object.keys(inputSchemas).length > 0 ? validationSchemasObjectToSingleValidationSchema(inputSchemas) : undefined;
|
|
48
|
+
if (!schema?.operationObject) {
|
|
50
49
|
throw new Error(`Handler "${handlerName}" in module "${moduleName}" does not have a valid schema.`);
|
|
51
50
|
}
|
|
52
51
|
const execute = async (input) => {
|
|
@@ -93,7 +92,7 @@ const makeTool = ({ moduleName, handlerName, module, meta, toModelOutput, onExec
|
|
|
93
92
|
type: 'function',
|
|
94
93
|
execute,
|
|
95
94
|
name: schema.operationObject?.['x-tool']?.name ?? `${moduleName}_${handlerName}`,
|
|
96
|
-
inputSchema:
|
|
95
|
+
inputSchema: inputSchema,
|
|
97
96
|
outputSchema: definition?.output,
|
|
98
97
|
title: schema.operationObject?.['x-tool']?.title ?? schema.operationObject?.summary,
|
|
99
98
|
description: schema.operationObject?.['x-tool']?.description ??
|