@agentica/core 0.43.2 → 0.44.0-dev.20260313

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 (205) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +218 -218
  3. package/lib/constants/AgenticaSystemPrompt.js +1 -1
  4. package/lib/constants/AgenticaSystemPrompt.js.map +1 -1
  5. package/lib/context/AgenticaOperation.d.ts +3 -2
  6. package/lib/context/internal/AgenticaOperationComposer.js.map +1 -1
  7. package/lib/context/internal/AgenticaTokenUsageAggregator.js.map +1 -1
  8. package/lib/context/internal/__IChatInitialApplication.d.ts +1 -1
  9. package/lib/errors/AgenticaJsonParseError.d.ts +5 -8
  10. package/lib/errors/AgenticaJsonParseError.js +11 -6
  11. package/lib/errors/AgenticaJsonParseError.js.map +1 -1
  12. package/lib/errors/AgenticaValidationError.d.ts +1 -1
  13. package/lib/events/AgenticaExecuteEvent.d.ts +1 -1
  14. package/lib/events/AgenticaJsonParseErrorEvent.d.ts +2 -2
  15. package/lib/factory/events.d.ts +2 -3
  16. package/lib/factory/events.js +1 -2
  17. package/lib/factory/events.js.map +1 -1
  18. package/lib/functional/assertHttpController.d.ts +2 -3
  19. package/lib/functional/assertHttpController.js +3939 -2656
  20. package/lib/functional/assertHttpController.js.map +1 -1
  21. package/lib/functional/assertHttpLlmApplication.d.ts +3 -3
  22. package/lib/functional/assertHttpLlmApplication.js +3939 -2656
  23. package/lib/functional/assertHttpLlmApplication.js.map +1 -1
  24. package/lib/functional/assertMcpController.d.ts +2 -2
  25. package/lib/functional/assertMcpController.js +202 -629
  26. package/lib/functional/assertMcpController.js.map +1 -1
  27. package/lib/functional/createMcpLlmApplication.d.ts +6 -0
  28. package/lib/functional/createMcpLlmApplication.js +56 -0
  29. package/lib/functional/createMcpLlmApplication.js.map +1 -0
  30. package/lib/functional/validateHttpController.d.ts +3 -3
  31. package/lib/functional/validateHttpController.js +3367 -2268
  32. package/lib/functional/validateHttpController.js.map +1 -1
  33. package/lib/functional/validateHttpLlmApplication.d.ts +3 -4
  34. package/lib/functional/validateHttpLlmApplication.js +3367 -2268
  35. package/lib/functional/validateHttpLlmApplication.js.map +1 -1
  36. package/lib/functional/validateMcpController.d.ts +2 -2
  37. package/lib/functional/validateMcpController.js +388 -1161
  38. package/lib/functional/validateMcpController.js.map +1 -1
  39. package/lib/histories/AgenticaExecuteHistory.d.ts +1 -1
  40. package/lib/index.mjs +21256 -18948
  41. package/lib/index.mjs.map +1 -1
  42. package/lib/orchestrate/call.js +43 -56
  43. package/lib/orchestrate/call.js.map +1 -1
  44. package/lib/orchestrate/cancel.js +9 -66
  45. package/lib/orchestrate/cancel.js.map +1 -1
  46. package/lib/orchestrate/initialize.js +4 -947
  47. package/lib/orchestrate/initialize.js.map +1 -1
  48. package/lib/orchestrate/select.js +11 -68
  49. package/lib/orchestrate/select.js.map +1 -1
  50. package/lib/structures/IAgenticaController.d.ts +143 -151
  51. package/lib/structures/IMcpTool.d.ts +52 -0
  52. package/lib/structures/IMcpTool.js +3 -0
  53. package/lib/structures/IMcpTool.js.map +1 -0
  54. package/lib/utils/ChatGptCompletionMessageUtil.js +16 -5
  55. package/lib/utils/ChatGptCompletionMessageUtil.js.map +1 -1
  56. package/lib/utils/ChatGptCompletionMessageUtil.spec.js +0 -5
  57. package/lib/utils/ChatGptCompletionMessageUtil.spec.js.map +1 -1
  58. package/package.json +7 -9
  59. package/prompts/cancel.md +5 -5
  60. package/prompts/common.md +3 -3
  61. package/prompts/describe.md +7 -7
  62. package/prompts/execute.md +122 -122
  63. package/prompts/initialize.md +3 -3
  64. package/prompts/json_parse_error.md +35 -33
  65. package/prompts/select.md +7 -7
  66. package/prompts/validate.md +123 -123
  67. package/prompts/validate_repeated.md +31 -31
  68. package/src/Agentica.ts +367 -367
  69. package/src/MicroAgentica.ts +357 -357
  70. package/src/constants/AgenticaConstant.ts +4 -4
  71. package/src/constants/AgenticaDefaultPrompt.ts +44 -44
  72. package/src/constants/AgenticaSystemPrompt.ts +1 -1
  73. package/src/constants/index.ts +2 -2
  74. package/src/context/AgenticaContext.ts +136 -136
  75. package/src/context/AgenticaContextRequestResult.ts +14 -14
  76. package/src/context/AgenticaOperation.ts +73 -72
  77. package/src/context/AgenticaOperationCollection.ts +49 -49
  78. package/src/context/AgenticaOperationSelection.ts +9 -9
  79. package/src/context/AgenticaTokenUsage.ts +186 -186
  80. package/src/context/MicroAgenticaContext.ts +99 -99
  81. package/src/context/index.ts +5 -5
  82. package/src/context/internal/AgenticaOperationComposer.ts +177 -177
  83. package/src/context/internal/AgenticaTokenUsageAggregator.ts +66 -66
  84. package/src/context/internal/__IChatCancelFunctionsApplication.ts +23 -23
  85. package/src/context/internal/__IChatFunctionReference.ts +21 -21
  86. package/src/context/internal/__IChatInitialApplication.ts +15 -15
  87. package/src/context/internal/__IChatSelectFunctionsApplication.ts +24 -24
  88. package/src/context/internal/isAgenticaContext.ts +11 -11
  89. package/src/errors/AgenticaJsonParseError.ts +52 -47
  90. package/src/errors/AgenticaValidationError.ts +49 -49
  91. package/src/errors/index.ts +2 -2
  92. package/src/events/AgenticaAssistantMessageEvent.ts +12 -12
  93. package/src/events/AgenticaCallEvent.ts +27 -27
  94. package/src/events/AgenticaCancelEvent.ts +9 -9
  95. package/src/events/AgenticaDescribeEvent.ts +14 -14
  96. package/src/events/AgenticaEvent.ts +59 -59
  97. package/src/events/AgenticaEvent.type.ts +19 -19
  98. package/src/events/AgenticaEventBase.ts +18 -18
  99. package/src/events/AgenticaEventSource.ts +6 -6
  100. package/src/events/AgenticaExecuteEvent.ts +45 -45
  101. package/src/events/AgenticaInitializeEvent.ts +7 -7
  102. package/src/events/AgenticaJsonParseErrorEvent.ts +16 -15
  103. package/src/events/AgenticaRequestEvent.ts +27 -27
  104. package/src/events/AgenticaResponseEvent.ts +32 -32
  105. package/src/events/AgenticaSelectEvent.ts +11 -11
  106. package/src/events/AgenticaUserMessageEvent.ts +12 -12
  107. package/src/events/AgenticaValidateEvent.ts +32 -32
  108. package/src/events/MicroAgenticaEvent.ts +45 -45
  109. package/src/events/index.ts +15 -15
  110. package/src/factory/events.ts +357 -359
  111. package/src/factory/histories.ts +348 -348
  112. package/src/factory/index.ts +3 -3
  113. package/src/factory/operations.ts +16 -16
  114. package/src/functional/assertHttpController.ts +106 -104
  115. package/src/functional/assertHttpLlmApplication.ts +52 -57
  116. package/src/functional/assertMcpController.ts +47 -44
  117. package/src/functional/createMcpLlmApplication.ts +72 -0
  118. package/src/functional/index.ts +7 -7
  119. package/src/functional/validateHttpController.ts +113 -110
  120. package/src/functional/validateHttpLlmApplication.ts +65 -70
  121. package/src/functional/validateMcpController.ts +53 -50
  122. package/src/histories/AgenticaAssistantMessageHistory.ts +10 -10
  123. package/src/histories/AgenticaCancelHistory.ts +8 -8
  124. package/src/histories/AgenticaDescribeHistory.ts +18 -18
  125. package/src/histories/AgenticaExecuteHistory.ts +64 -64
  126. package/src/histories/AgenticaHistory.ts +28 -28
  127. package/src/histories/AgenticaHistoryBase.ts +35 -35
  128. package/src/histories/AgenticaSelectHistory.ts +8 -8
  129. package/src/histories/AgenticaSystemMessageHistory.ts +10 -10
  130. package/src/histories/AgenticaUserMessageHistory.ts +11 -11
  131. package/src/histories/MicroAgenticaHistory.ts +19 -19
  132. package/src/histories/contents/AgenticaUserMessageAudioContent.ts +21 -21
  133. package/src/histories/contents/AgenticaUserMessageContent.ts +19 -19
  134. package/src/histories/contents/AgenticaUserMessageContentBase.ts +6 -6
  135. package/src/histories/contents/AgenticaUserMessageFileContent.ts +25 -25
  136. package/src/histories/contents/AgenticaUserMessageImageContent.ts +33 -33
  137. package/src/histories/contents/AgenticaUserMessageTextContent.ts +15 -15
  138. package/src/histories/contents/index.ts +5 -5
  139. package/src/histories/index.ts +10 -10
  140. package/src/index.ts +15 -15
  141. package/src/json/IAgenticaEventJson.ts +265 -265
  142. package/src/json/IAgenticaEventJson.type.ts +19 -19
  143. package/src/json/IAgenticaHistoryJson.ts +165 -165
  144. package/src/json/IAgenticaHistoryJson.type.ts +19 -19
  145. package/src/json/IAgenticaOperationJson.ts +36 -36
  146. package/src/json/IAgenticaOperationSelectionJson.ts +26 -26
  147. package/src/json/IAgenticaTokenUsageJson.ts +107 -107
  148. package/src/json/IMicroAgenticaEventJson.ts +22 -22
  149. package/src/json/IMicroAgenticaHistoryJson.ts +25 -25
  150. package/src/json/index.ts +7 -7
  151. package/src/orchestrate/call.ts +542 -558
  152. package/src/orchestrate/cancel.ts +265 -269
  153. package/src/orchestrate/describe.ts +66 -66
  154. package/src/orchestrate/execute.ts +61 -61
  155. package/src/orchestrate/index.ts +6 -6
  156. package/src/orchestrate/initialize.ts +102 -102
  157. package/src/orchestrate/internal/cancelFunctionFromContext.ts +33 -33
  158. package/src/orchestrate/internal/selectFunctionFromContext.ts +34 -34
  159. package/src/orchestrate/select.ts +320 -322
  160. package/src/structures/IAgenticaConfig.ts +83 -83
  161. package/src/structures/IAgenticaConfigBase.ts +87 -87
  162. package/src/structures/IAgenticaController.ts +143 -151
  163. package/src/structures/IAgenticaExecutor.ts +167 -167
  164. package/src/structures/IAgenticaProps.ts +78 -78
  165. package/src/structures/IAgenticaSystemPrompt.ts +236 -236
  166. package/src/structures/IAgenticaVendor.ts +54 -54
  167. package/src/structures/IMcpTool.ts +60 -0
  168. package/src/structures/IMicroAgenticaConfig.ts +56 -56
  169. package/src/structures/IMicroAgenticaExecutor.ts +67 -67
  170. package/src/structures/IMicroAgenticaProps.ts +77 -77
  171. package/src/structures/IMicroAgenticaSystemPrompt.ts +169 -169
  172. package/src/structures/index.ts +10 -10
  173. package/src/transformers/transformHistory.ts +172 -172
  174. package/src/utils/AssistantMessageEmptyError.ts +20 -20
  175. package/src/utils/AsyncQueue.spec.ts +355 -355
  176. package/src/utils/AsyncQueue.ts +95 -95
  177. package/src/utils/ByteArrayUtil.ts +5 -5
  178. package/src/utils/ChatGptCompletionMessageUtil.spec.ts +314 -320
  179. package/src/utils/ChatGptCompletionMessageUtil.ts +210 -195
  180. package/src/utils/ChatGptCompletionStreamingUtil.spec.ts +909 -909
  181. package/src/utils/ChatGptCompletionStreamingUtil.ts +91 -91
  182. package/src/utils/ChatGptTokenUsageAggregator.spec.ts +226 -226
  183. package/src/utils/ChatGptTokenUsageAggregator.ts +57 -57
  184. package/src/utils/MPSC.spec.ts +276 -276
  185. package/src/utils/MPSC.ts +42 -42
  186. package/src/utils/Singleton.spec.ts +138 -138
  187. package/src/utils/Singleton.ts +42 -42
  188. package/src/utils/StreamUtil.spec.ts +512 -512
  189. package/src/utils/StreamUtil.ts +87 -87
  190. package/src/utils/__map_take.spec.ts +140 -140
  191. package/src/utils/__map_take.ts +13 -13
  192. package/src/utils/__retry.spec.ts +198 -198
  193. package/src/utils/__retry.ts +18 -18
  194. package/src/utils/assertExecuteFailure.ts +16 -16
  195. package/src/utils/index.ts +4 -4
  196. package/src/utils/request.ts +140 -140
  197. package/src/utils/types.ts +50 -50
  198. package/lib/context/internal/AgenticaOperationComposer.spec.d.ts +0 -1
  199. package/lib/context/internal/AgenticaOperationComposer.spec.js +0 -353
  200. package/lib/context/internal/AgenticaOperationComposer.spec.js.map +0 -1
  201. package/lib/utils/JsonUtil.d.ts +0 -8
  202. package/lib/utils/JsonUtil.js +0 -350
  203. package/lib/utils/JsonUtil.js.map +0 -1
  204. package/src/context/internal/AgenticaOperationComposer.spec.ts +0 -401
  205. package/src/utils/JsonUtil.ts +0 -462
@@ -1,140 +1,140 @@
1
- import type OpenAI from "openai";
2
-
3
- import { v4 } from "uuid";
4
-
5
- import type { AgenticaContextRequestResult } from "../context/AgenticaContextRequestResult";
6
- import type { AgenticaTokenUsage } from "../context/AgenticaTokenUsage";
7
- import type { AgenticaEventSource, AgenticaRequestEvent, AgenticaResponseEvent } from "../events";
8
- import type { IAgenticaConfig, IAgenticaVendor, IMicroAgenticaConfig } from "../structures";
9
-
10
- import { AgenticaTokenUsageAggregator } from "../context/internal/AgenticaTokenUsageAggregator";
11
- import { createRequestEvent } from "../factory";
12
-
13
- import { ChatGptCompletionMessageUtil } from "./ChatGptCompletionMessageUtil";
14
- import { streamDefaultReaderToAsyncGenerator, StreamUtil } from "./StreamUtil";
15
-
16
- export function getChatCompletionFunction(props: {
17
- vendor: IAgenticaVendor;
18
- config?: IAgenticaConfig | IMicroAgenticaConfig;
19
- dispatch: (event: AgenticaRequestEvent | AgenticaResponseEvent) => Promise<void>;
20
- abortSignal?: AbortSignal;
21
- usage: AgenticaTokenUsage;
22
- }) {
23
- return async (
24
- source: AgenticaEventSource,
25
- body: Omit<OpenAI.ChatCompletionCreateParamsStreaming | OpenAI.ChatCompletionCreateParamsNonStreaming, "model">,
26
- ): Promise<AgenticaContextRequestResult> => {
27
- const streamOptions = props.config?.stream === true || props.config?.stream === undefined
28
- ? { stream: true, stream_options: { include_usage: true } }
29
- : { stream: false };
30
- const event: AgenticaRequestEvent = createRequestEvent({
31
- source,
32
- stream: streamOptions.stream,
33
- body: {
34
- ...body,
35
- model: props.vendor.model,
36
- ...streamOptions,
37
- },
38
- options: {
39
- ...props.vendor.options,
40
- signal: props.abortSignal,
41
- },
42
- });
43
- await props.dispatch(event);
44
-
45
- // completion
46
- const backoffStrategy = props.config?.backoffStrategy ?? ((props) => {
47
- throw props.error;
48
- });
49
- const completion = await (async () => {
50
- let count = 0;
51
- while (true) {
52
- try {
53
- return await props.vendor.api.chat.completions.create(
54
- event.body,
55
- event.options,
56
- );
57
- }
58
- catch (error) {
59
- const waiting = backoffStrategy({ count, error });
60
- await new Promise(resolve => setTimeout(resolve, waiting));
61
- count++;
62
- }
63
- }
64
- })();
65
-
66
- if ("toReadableStream" in completion === false) {
67
- if (completion.usage != null) {
68
- AgenticaTokenUsageAggregator.aggregate({
69
- kind: source,
70
- completionUsage: completion.usage,
71
- usage: props.usage,
72
- });
73
- }
74
- void props.dispatch({
75
- id: v4(),
76
- type: "response",
77
- request_id: event.id,
78
- source,
79
- stream: false,
80
- body: event.body as OpenAI.ChatCompletionCreateParamsNonStreaming,
81
- completion,
82
- options: event.options,
83
- join: async () => completion,
84
- created_at: new Date().toISOString(),
85
- }).catch(() => {});
86
- return {
87
- type: "none-stream",
88
- value: completion,
89
- };
90
- }
91
-
92
- const [streamForEvent, temporaryStream] = StreamUtil.transform(
93
- completion.toReadableStream() as ReadableStream<Uint8Array>,
94
- value =>
95
- ChatGptCompletionMessageUtil.transformCompletionChunk(value),
96
- props.abortSignal,
97
- ).tee();
98
-
99
- const [streamForAggregate, streamForReturn] = temporaryStream.tee();
100
-
101
- (async () => {
102
- const reader = streamForAggregate.getReader();
103
- while (true) {
104
- const chunk = await reader.read();
105
- if (chunk.done || props.abortSignal?.aborted === true) {
106
- break;
107
- }
108
- if (chunk.value.usage != null) {
109
- AgenticaTokenUsageAggregator.aggregate({
110
- kind: source,
111
- completionUsage: chunk.value.usage,
112
- usage: props.usage,
113
- });
114
- }
115
- }
116
- })().catch(() => {});
117
-
118
- const [streamForStream, streamForJoin] = streamForEvent.tee();
119
- void props.dispatch({
120
- id: v4(),
121
- type: "response",
122
- request_id: event.id,
123
- source,
124
- stream: true,
125
- body: event.body as OpenAI.ChatCompletionCreateParamsStreaming,
126
- completion: streamDefaultReaderToAsyncGenerator(streamForStream.getReader(), props.abortSignal),
127
- options: event.options,
128
- join: async () => {
129
- const chunks = await StreamUtil.readAll(streamForJoin, props.abortSignal);
130
- return ChatGptCompletionMessageUtil.merge(chunks);
131
- },
132
- created_at: new Date().toISOString(),
133
- }).catch(() => {});
134
-
135
- return {
136
- type: "stream",
137
- value: streamForReturn,
138
- };
139
- };
140
- }
1
+ import type OpenAI from "openai";
2
+
3
+ import { v4 } from "uuid";
4
+
5
+ import type { AgenticaContextRequestResult } from "../context/AgenticaContextRequestResult";
6
+ import type { AgenticaTokenUsage } from "../context/AgenticaTokenUsage";
7
+ import type { AgenticaEventSource, AgenticaRequestEvent, AgenticaResponseEvent } from "../events";
8
+ import type { IAgenticaConfig, IAgenticaVendor, IMicroAgenticaConfig } from "../structures";
9
+
10
+ import { AgenticaTokenUsageAggregator } from "../context/internal/AgenticaTokenUsageAggregator";
11
+ import { createRequestEvent } from "../factory";
12
+
13
+ import { ChatGptCompletionMessageUtil } from "./ChatGptCompletionMessageUtil";
14
+ import { streamDefaultReaderToAsyncGenerator, StreamUtil } from "./StreamUtil";
15
+
16
+ export function getChatCompletionFunction(props: {
17
+ vendor: IAgenticaVendor;
18
+ config?: IAgenticaConfig | IMicroAgenticaConfig;
19
+ dispatch: (event: AgenticaRequestEvent | AgenticaResponseEvent) => Promise<void>;
20
+ abortSignal?: AbortSignal;
21
+ usage: AgenticaTokenUsage;
22
+ }) {
23
+ return async (
24
+ source: AgenticaEventSource,
25
+ body: Omit<OpenAI.ChatCompletionCreateParamsStreaming | OpenAI.ChatCompletionCreateParamsNonStreaming, "model">,
26
+ ): Promise<AgenticaContextRequestResult> => {
27
+ const streamOptions = props.config?.stream === true || props.config?.stream === undefined
28
+ ? { stream: true, stream_options: { include_usage: true } }
29
+ : { stream: false };
30
+ const event: AgenticaRequestEvent = createRequestEvent({
31
+ source,
32
+ stream: streamOptions.stream,
33
+ body: {
34
+ ...body,
35
+ model: props.vendor.model,
36
+ ...streamOptions,
37
+ },
38
+ options: {
39
+ ...props.vendor.options,
40
+ signal: props.abortSignal,
41
+ },
42
+ });
43
+ await props.dispatch(event);
44
+
45
+ // completion
46
+ const backoffStrategy = props.config?.backoffStrategy ?? ((props) => {
47
+ throw props.error;
48
+ });
49
+ const completion = await (async () => {
50
+ let count = 0;
51
+ while (true) {
52
+ try {
53
+ return await props.vendor.api.chat.completions.create(
54
+ event.body,
55
+ event.options,
56
+ );
57
+ }
58
+ catch (error) {
59
+ const waiting = backoffStrategy({ count, error });
60
+ await new Promise(resolve => setTimeout(resolve, waiting));
61
+ count++;
62
+ }
63
+ }
64
+ })();
65
+
66
+ if ("toReadableStream" in completion === false) {
67
+ if (completion.usage != null) {
68
+ AgenticaTokenUsageAggregator.aggregate({
69
+ kind: source,
70
+ completionUsage: completion.usage,
71
+ usage: props.usage,
72
+ });
73
+ }
74
+ void props.dispatch({
75
+ id: v4(),
76
+ type: "response",
77
+ request_id: event.id,
78
+ source,
79
+ stream: false,
80
+ body: event.body as OpenAI.ChatCompletionCreateParamsNonStreaming,
81
+ completion,
82
+ options: event.options,
83
+ join: async () => completion,
84
+ created_at: new Date().toISOString(),
85
+ }).catch(() => {});
86
+ return {
87
+ type: "none-stream",
88
+ value: completion,
89
+ };
90
+ }
91
+
92
+ const [streamForEvent, temporaryStream] = StreamUtil.transform(
93
+ completion.toReadableStream() as ReadableStream<Uint8Array>,
94
+ value =>
95
+ ChatGptCompletionMessageUtil.transformCompletionChunk(value),
96
+ props.abortSignal,
97
+ ).tee();
98
+
99
+ const [streamForAggregate, streamForReturn] = temporaryStream.tee();
100
+
101
+ (async () => {
102
+ const reader = streamForAggregate.getReader();
103
+ while (true) {
104
+ const chunk = await reader.read();
105
+ if (chunk.done || props.abortSignal?.aborted === true) {
106
+ break;
107
+ }
108
+ if (chunk.value.usage != null) {
109
+ AgenticaTokenUsageAggregator.aggregate({
110
+ kind: source,
111
+ completionUsage: chunk.value.usage,
112
+ usage: props.usage,
113
+ });
114
+ }
115
+ }
116
+ })().catch(() => {});
117
+
118
+ const [streamForStream, streamForJoin] = streamForEvent.tee();
119
+ void props.dispatch({
120
+ id: v4(),
121
+ type: "response",
122
+ request_id: event.id,
123
+ source,
124
+ stream: true,
125
+ body: event.body as OpenAI.ChatCompletionCreateParamsStreaming,
126
+ completion: streamDefaultReaderToAsyncGenerator(streamForStream.getReader(), props.abortSignal),
127
+ options: event.options,
128
+ join: async () => {
129
+ const chunks = await StreamUtil.readAll(streamForJoin, props.abortSignal);
130
+ return ChatGptCompletionMessageUtil.merge(chunks);
131
+ },
132
+ created_at: new Date().toISOString(),
133
+ }).catch(() => {});
134
+
135
+ return {
136
+ type: "stream",
137
+ value: streamForReturn,
138
+ };
139
+ };
140
+ }
@@ -1,50 +1,50 @@
1
- /**
2
- * from ts-toolbelt repository
3
- * https://github.com/millsp/ts-toolbelt/blob/master/sources/Test.ts
4
- */
5
-
6
- type Equals<A1, A2> = (<A>() => A extends A2 ? 1 : 0) extends <
7
- A,
8
- >() => A extends A1 ? 1 : 0
9
- ? 1
10
- : 0;
11
-
12
- type Boolean = 0 | 1;
13
- /**
14
- * Test should pass
15
- */
16
- export type Pass = 1;
17
-
18
- /**
19
- * Test should fail
20
- */
21
- export type Fail = 0;
22
-
23
- /**
24
- * Check or test the validity of a type
25
- * @param debug to debug with parameter hints (`ctrl+p`, `ctrl+shift+space`)
26
- * @example
27
- * ```ts
28
- * // see in `tst` folder
29
- * ```
30
- */
31
- export function check<Type, Expect, Outcome extends Boolean>(
32
- debug?: Type,
33
- ): Equals<Equals<Type, Expect>, Outcome> {
34
- if (debug !== undefined) {
35
- // eslint-disable-next-line no-console
36
- console.log(debug);
37
- }
38
-
39
- return 1 as Equals<Equals<Type, Expect>, Outcome>;
40
- }
41
-
42
- /**
43
- * Validates a batch of [[check]]
44
- * @param _checks a batch of [[check]]
45
- * @example
46
- * ```ts
47
- * // see in `tst` folder
48
- * ```
49
- */
50
- export function checks(_checks: 1[]): void { }
1
+ /**
2
+ * from ts-toolbelt repository
3
+ * https://github.com/millsp/ts-toolbelt/blob/master/sources/Test.ts
4
+ */
5
+
6
+ type Equals<A1, A2> = (<A>() => A extends A2 ? 1 : 0) extends <
7
+ A,
8
+ >() => A extends A1 ? 1 : 0
9
+ ? 1
10
+ : 0;
11
+
12
+ type Boolean = 0 | 1;
13
+ /**
14
+ * Test should pass
15
+ */
16
+ export type Pass = 1;
17
+
18
+ /**
19
+ * Test should fail
20
+ */
21
+ export type Fail = 0;
22
+
23
+ /**
24
+ * Check or test the validity of a type
25
+ * @param debug to debug with parameter hints (`ctrl+p`, `ctrl+shift+space`)
26
+ * @example
27
+ * ```ts
28
+ * // see in `tst` folder
29
+ * ```
30
+ */
31
+ export function check<Type, Expect, Outcome extends Boolean>(
32
+ debug?: Type,
33
+ ): Equals<Equals<Type, Expect>, Outcome> {
34
+ if (debug !== undefined) {
35
+ // eslint-disable-next-line no-console
36
+ console.log(debug);
37
+ }
38
+
39
+ return 1 as Equals<Equals<Type, Expect>, Outcome>;
40
+ }
41
+
42
+ /**
43
+ * Validates a batch of [[check]]
44
+ * @param _checks a batch of [[check]]
45
+ * @example
46
+ * ```ts
47
+ * // see in `tst` folder
48
+ * ```
49
+ */
50
+ export function checks(_checks: 1[]): void { }