vellum-ai 0.6.8 → 0.6.11

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 (166) hide show
  1. package/Client.d.ts +9 -6
  2. package/Client.js +40 -37
  3. package/api/client/requests/ExecutePromptRequest.d.ts +7 -5
  4. package/api/client/requests/ExecutePromptStreamRequest.d.ts +7 -5
  5. package/api/resources/deployments/client/Client.d.ts +8 -5
  6. package/api/resources/deployments/client/Client.js +22 -17
  7. package/api/resources/documentIndexes/client/Client.d.ts +21 -7
  8. package/api/resources/documentIndexes/client/Client.js +77 -26
  9. package/api/resources/documents/client/Client.d.ts +11 -7
  10. package/api/resources/documents/client/Client.js +25 -22
  11. package/api/resources/folderEntities/client/Client.d.ts +4 -1
  12. package/api/resources/folderEntities/client/Client.js +4 -3
  13. package/api/resources/sandboxes/client/Client.d.ts +7 -4
  14. package/api/resources/sandboxes/client/Client.js +14 -13
  15. package/api/resources/testSuiteRuns/client/Client.d.ts +6 -3
  16. package/api/resources/testSuiteRuns/client/Client.js +13 -10
  17. package/api/resources/testSuites/client/Client.d.ts +6 -3
  18. package/api/resources/testSuites/client/Client.js +16 -14
  19. package/api/resources/workflowDeployments/client/Client.d.ts +7 -4
  20. package/api/resources/workflowDeployments/client/Client.js +17 -13
  21. package/api/resources/workflowSandboxes/client/Client.d.ts +4 -1
  22. package/api/resources/workflowSandboxes/client/Client.js +5 -6
  23. package/api/types/IterationStateEnum.d.ts +12 -0
  24. package/api/types/IterationStateEnum.js +10 -0
  25. package/api/types/MapNodeResultData.d.ts +2 -0
  26. package/api/types/PromptNodeResultData.d.ts +1 -0
  27. package/api/types/TestSuiteRunMetricNumberOutput.d.ts +1 -1
  28. package/api/types/TestSuiteRunMetricStringOutput.d.ts +1 -1
  29. package/api/types/TestSuiteTestCaseRejectedBulkResult.d.ts +1 -1
  30. package/api/types/index.d.ts +1 -0
  31. package/api/types/index.js +1 -0
  32. package/core/fetcher/Fetcher.d.ts +2 -0
  33. package/core/fetcher/Fetcher.js +19 -185
  34. package/core/fetcher/createRequestUrl.d.ts +1 -0
  35. package/core/fetcher/createRequestUrl.js +13 -0
  36. package/core/fetcher/getFetchFn.d.ts +4 -0
  37. package/core/fetcher/getFetchFn.js +55 -0
  38. package/core/fetcher/getRequestBody.d.ts +7 -0
  39. package/core/fetcher/getRequestBody.js +23 -0
  40. package/core/fetcher/getResponseBody.d.ts +1 -0
  41. package/core/fetcher/getResponseBody.js +48 -0
  42. package/core/fetcher/makeRequest.d.ts +1 -0
  43. package/core/fetcher/makeRequest.js +40 -0
  44. package/core/fetcher/requestWithRetries.d.ts +1 -0
  45. package/core/fetcher/requestWithRetries.js +32 -0
  46. package/core/fetcher/signals.d.ts +12 -0
  47. package/core/fetcher/signals.js +37 -0
  48. package/core/form-data-utils/FormDataWrapper.d.ts +10 -21
  49. package/core/form-data-utils/FormDataWrapper.js +82 -49
  50. package/core/runtime/runtime.d.ts +1 -0
  51. package/core/runtime/runtime.js +1 -0
  52. package/core/schemas/Schema.d.ts +7 -4
  53. package/core/schemas/builders/lazy/lazy.d.ts +2 -2
  54. package/core/schemas/builders/lazy/lazy.js +8 -19
  55. package/core/schemas/builders/lazy/lazyObject.js +1 -10
  56. package/core/schemas/builders/list/list.js +31 -44
  57. package/core/schemas/builders/object/object.js +90 -111
  58. package/core/schemas/builders/object/types.d.ts +2 -2
  59. package/core/schemas/builders/object-like/getObjectLikeUtils.js +3 -12
  60. package/core/schemas/builders/record/record.js +49 -60
  61. package/core/schemas/builders/schema-utils/getSchemaUtils.d.ts +2 -2
  62. package/core/schemas/builders/schema-utils/getSchemaUtils.js +18 -21
  63. package/core/schemas/builders/set/set.js +6 -15
  64. package/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.js +21 -32
  65. package/core/schemas/builders/union/union.js +51 -62
  66. package/core/schemas/utils/maybeSkipValidation.js +3 -12
  67. package/dist/Client.d.ts +9 -6
  68. package/dist/Client.js +40 -37
  69. package/dist/api/client/requests/ExecutePromptRequest.d.ts +7 -5
  70. package/dist/api/client/requests/ExecutePromptStreamRequest.d.ts +7 -5
  71. package/dist/api/resources/deployments/client/Client.d.ts +8 -5
  72. package/dist/api/resources/deployments/client/Client.js +22 -17
  73. package/dist/api/resources/documentIndexes/client/Client.d.ts +21 -7
  74. package/dist/api/resources/documentIndexes/client/Client.js +77 -26
  75. package/dist/api/resources/documents/client/Client.d.ts +11 -7
  76. package/dist/api/resources/documents/client/Client.js +25 -22
  77. package/dist/api/resources/folderEntities/client/Client.d.ts +4 -1
  78. package/dist/api/resources/folderEntities/client/Client.js +4 -3
  79. package/dist/api/resources/sandboxes/client/Client.d.ts +7 -4
  80. package/dist/api/resources/sandboxes/client/Client.js +14 -13
  81. package/dist/api/resources/testSuiteRuns/client/Client.d.ts +6 -3
  82. package/dist/api/resources/testSuiteRuns/client/Client.js +13 -10
  83. package/dist/api/resources/testSuites/client/Client.d.ts +6 -3
  84. package/dist/api/resources/testSuites/client/Client.js +16 -14
  85. package/dist/api/resources/workflowDeployments/client/Client.d.ts +7 -4
  86. package/dist/api/resources/workflowDeployments/client/Client.js +17 -13
  87. package/dist/api/resources/workflowSandboxes/client/Client.d.ts +4 -1
  88. package/dist/api/resources/workflowSandboxes/client/Client.js +5 -6
  89. package/dist/api/types/IterationStateEnum.d.ts +12 -0
  90. package/dist/api/types/IterationStateEnum.js +10 -0
  91. package/dist/api/types/MapNodeResultData.d.ts +2 -0
  92. package/dist/api/types/PromptNodeResultData.d.ts +1 -0
  93. package/dist/api/types/TestSuiteRunMetricNumberOutput.d.ts +1 -1
  94. package/dist/api/types/TestSuiteRunMetricStringOutput.d.ts +1 -1
  95. package/dist/api/types/TestSuiteTestCaseRejectedBulkResult.d.ts +1 -1
  96. package/dist/api/types/index.d.ts +1 -0
  97. package/dist/api/types/index.js +1 -0
  98. package/dist/core/fetcher/Fetcher.d.ts +2 -0
  99. package/dist/core/fetcher/Fetcher.js +19 -185
  100. package/dist/core/fetcher/createRequestUrl.d.ts +1 -0
  101. package/dist/core/fetcher/createRequestUrl.js +13 -0
  102. package/dist/core/fetcher/getFetchFn.d.ts +4 -0
  103. package/dist/core/fetcher/getFetchFn.js +55 -0
  104. package/dist/core/fetcher/getRequestBody.d.ts +7 -0
  105. package/dist/core/fetcher/getRequestBody.js +23 -0
  106. package/dist/core/fetcher/getResponseBody.d.ts +1 -0
  107. package/dist/core/fetcher/getResponseBody.js +48 -0
  108. package/dist/core/fetcher/makeRequest.d.ts +1 -0
  109. package/dist/core/fetcher/makeRequest.js +40 -0
  110. package/dist/core/fetcher/requestWithRetries.d.ts +1 -0
  111. package/dist/core/fetcher/requestWithRetries.js +32 -0
  112. package/dist/core/fetcher/signals.d.ts +12 -0
  113. package/dist/core/fetcher/signals.js +37 -0
  114. package/dist/core/form-data-utils/FormDataWrapper.d.ts +10 -21
  115. package/dist/core/form-data-utils/FormDataWrapper.js +82 -49
  116. package/dist/core/runtime/runtime.d.ts +1 -0
  117. package/dist/core/runtime/runtime.js +1 -0
  118. package/dist/core/schemas/Schema.d.ts +7 -4
  119. package/dist/core/schemas/builders/lazy/lazy.d.ts +2 -2
  120. package/dist/core/schemas/builders/lazy/lazy.js +8 -19
  121. package/dist/core/schemas/builders/lazy/lazyObject.js +1 -10
  122. package/dist/core/schemas/builders/list/list.js +31 -44
  123. package/dist/core/schemas/builders/object/object.js +90 -111
  124. package/dist/core/schemas/builders/object/types.d.ts +2 -2
  125. package/dist/core/schemas/builders/object-like/getObjectLikeUtils.js +3 -12
  126. package/dist/core/schemas/builders/record/record.js +49 -60
  127. package/dist/core/schemas/builders/schema-utils/getSchemaUtils.d.ts +2 -2
  128. package/dist/core/schemas/builders/schema-utils/getSchemaUtils.js +18 -21
  129. package/dist/core/schemas/builders/set/set.js +6 -15
  130. package/dist/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.js +21 -32
  131. package/dist/core/schemas/builders/union/union.js +51 -62
  132. package/dist/core/schemas/utils/maybeSkipValidation.js +3 -12
  133. package/dist/serialization/types/IterationStateEnum.d.ts +10 -0
  134. package/dist/serialization/types/IterationStateEnum.js +31 -0
  135. package/dist/serialization/types/MapNodeResultData.d.ts +2 -0
  136. package/dist/serialization/types/MapNodeResultData.js +2 -0
  137. package/dist/serialization/types/MetadataFilterConfigRequest.js +2 -10
  138. package/dist/serialization/types/MetadataFilterRuleRequest.js +2 -10
  139. package/dist/serialization/types/PromptNodeResultData.d.ts +1 -0
  140. package/dist/serialization/types/PromptNodeResultData.js +1 -0
  141. package/dist/serialization/types/TestSuiteRunMetricNumberOutput.d.ts +1 -1
  142. package/dist/serialization/types/TestSuiteRunMetricNumberOutput.js +1 -1
  143. package/dist/serialization/types/TestSuiteRunMetricStringOutput.d.ts +1 -1
  144. package/dist/serialization/types/TestSuiteRunMetricStringOutput.js +1 -1
  145. package/dist/serialization/types/TestSuiteTestCaseRejectedBulkResult.d.ts +1 -1
  146. package/dist/serialization/types/TestSuiteTestCaseRejectedBulkResult.js +1 -1
  147. package/dist/serialization/types/index.d.ts +1 -0
  148. package/dist/serialization/types/index.js +1 -0
  149. package/package.json +6 -1
  150. package/reference.md +2418 -0
  151. package/serialization/types/IterationStateEnum.d.ts +10 -0
  152. package/serialization/types/IterationStateEnum.js +31 -0
  153. package/serialization/types/MapNodeResultData.d.ts +2 -0
  154. package/serialization/types/MapNodeResultData.js +2 -0
  155. package/serialization/types/MetadataFilterConfigRequest.js +2 -10
  156. package/serialization/types/MetadataFilterRuleRequest.js +2 -10
  157. package/serialization/types/PromptNodeResultData.d.ts +1 -0
  158. package/serialization/types/PromptNodeResultData.js +1 -0
  159. package/serialization/types/TestSuiteRunMetricNumberOutput.d.ts +1 -1
  160. package/serialization/types/TestSuiteRunMetricNumberOutput.js +1 -1
  161. package/serialization/types/TestSuiteRunMetricStringOutput.d.ts +1 -1
  162. package/serialization/types/TestSuiteRunMetricStringOutput.js +1 -1
  163. package/serialization/types/TestSuiteTestCaseRejectedBulkResult.d.ts +1 -1
  164. package/serialization/types/TestSuiteTestCaseRejectedBulkResult.js +1 -1
  165. package/serialization/types/index.d.ts +1 -0
  166. package/serialization/types/index.js +1 -0
@@ -0,0 +1,23 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.getRequestBody = void 0;
13
+ function getRequestBody({ body, type }) {
14
+ return __awaiter(this, void 0, void 0, function* () {
15
+ if (type.includes("json")) {
16
+ return JSON.stringify(body);
17
+ }
18
+ else {
19
+ return body;
20
+ }
21
+ });
22
+ }
23
+ exports.getRequestBody = getRequestBody;
@@ -0,0 +1 @@
1
+ export declare function getResponseBody(response: Response, responseType?: string): Promise<unknown>;
@@ -0,0 +1,48 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.getResponseBody = void 0;
13
+ function getResponseBody(response, responseType) {
14
+ return __awaiter(this, void 0, void 0, function* () {
15
+ if (response.body != null && responseType === "blob") {
16
+ return yield response.blob();
17
+ }
18
+ else if (response.body != null && responseType === "streaming") {
19
+ return response.body;
20
+ }
21
+ else if (response.body != null && responseType === "text") {
22
+ return yield response.text();
23
+ }
24
+ else {
25
+ const text = yield response.text();
26
+ if (text.length > 0) {
27
+ try {
28
+ let responseBody = JSON.parse(text);
29
+ return responseBody;
30
+ }
31
+ catch (err) {
32
+ return {
33
+ ok: false,
34
+ error: {
35
+ reason: "non-json",
36
+ statusCode: response.status,
37
+ rawBody: text,
38
+ },
39
+ };
40
+ }
41
+ }
42
+ else {
43
+ return undefined;
44
+ }
45
+ }
46
+ });
47
+ }
48
+ exports.getResponseBody = getResponseBody;
@@ -0,0 +1 @@
1
+ export declare const makeRequest: (fetchFn: (url: string, init: RequestInit) => Promise<Response>, url: string, method: string, headers: Record<string, string>, requestBody: BodyInit | undefined, timeoutMs?: number | undefined, abortSignal?: AbortSignal | undefined, withCredentials?: boolean | undefined) => Promise<Response>;
@@ -0,0 +1,40 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.makeRequest = void 0;
13
+ const signals_1 = require("./signals");
14
+ const makeRequest = (fetchFn, url, method, headers, requestBody, timeoutMs, abortSignal, withCredentials) => __awaiter(void 0, void 0, void 0, function* () {
15
+ const signals = [];
16
+ // Add timeout signal
17
+ let timeoutAbortId = undefined;
18
+ if (timeoutMs != null) {
19
+ const { signal, abortId } = (0, signals_1.getTimeoutSignal)(timeoutMs);
20
+ timeoutAbortId = abortId;
21
+ signals.push(signal);
22
+ }
23
+ // Add arbitrary signal
24
+ if (abortSignal != null) {
25
+ signals.push(abortSignal);
26
+ }
27
+ let newSignals = (0, signals_1.anySignal)(signals);
28
+ const response = yield fetchFn(url, {
29
+ method: method,
30
+ headers,
31
+ body: requestBody,
32
+ signal: newSignals,
33
+ credentials: withCredentials ? "include" : undefined,
34
+ });
35
+ if (timeoutAbortId != null) {
36
+ clearTimeout(timeoutAbortId);
37
+ }
38
+ return response;
39
+ });
40
+ exports.makeRequest = makeRequest;
@@ -0,0 +1 @@
1
+ export declare function requestWithRetries(requestFn: () => Promise<Response>, maxRetries?: number): Promise<Response>;
@@ -0,0 +1,32 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.requestWithRetries = void 0;
13
+ const INITIAL_RETRY_DELAY = 1;
14
+ const MAX_RETRY_DELAY = 60;
15
+ const DEFAULT_MAX_RETRIES = 2;
16
+ function requestWithRetries(requestFn, maxRetries = DEFAULT_MAX_RETRIES) {
17
+ return __awaiter(this, void 0, void 0, function* () {
18
+ let response = yield requestFn();
19
+ for (let i = 0; i < maxRetries; ++i) {
20
+ if ([408, 409, 429].includes(response.status) || response.status >= 500) {
21
+ const delay = Math.min(INITIAL_RETRY_DELAY * Math.pow(2, i), MAX_RETRY_DELAY);
22
+ yield new Promise((resolve) => setTimeout(resolve, delay));
23
+ response = yield requestFn();
24
+ }
25
+ else {
26
+ break;
27
+ }
28
+ }
29
+ return response;
30
+ });
31
+ }
32
+ exports.requestWithRetries = requestWithRetries;
@@ -0,0 +1,12 @@
1
+ /// <reference types="node" />
2
+ export declare function getTimeoutSignal(timeoutMs: number): {
3
+ signal: AbortSignal;
4
+ abortId: NodeJS.Timeout;
5
+ };
6
+ /**
7
+ * Returns an abort signal that is getting aborted when
8
+ * at least one of the specified abort signals is aborted.
9
+ *
10
+ * Requires at least node.js 18.
11
+ */
12
+ export declare function anySignal(...args: AbortSignal[] | [AbortSignal[]]): AbortSignal;
@@ -0,0 +1,37 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.anySignal = exports.getTimeoutSignal = void 0;
4
+ const TIMEOUT = "timeout";
5
+ function getTimeoutSignal(timeoutMs) {
6
+ const controller = new AbortController();
7
+ const abortId = setTimeout(() => controller.abort(TIMEOUT), timeoutMs);
8
+ return { signal: controller.signal, abortId };
9
+ }
10
+ exports.getTimeoutSignal = getTimeoutSignal;
11
+ /**
12
+ * Returns an abort signal that is getting aborted when
13
+ * at least one of the specified abort signals is aborted.
14
+ *
15
+ * Requires at least node.js 18.
16
+ */
17
+ function anySignal(...args) {
18
+ // Allowing signals to be passed either as array
19
+ // of signals or as multiple arguments.
20
+ const signals = (args.length === 1 && Array.isArray(args[0]) ? args[0] : args);
21
+ const controller = new AbortController();
22
+ for (const signal of signals) {
23
+ if (signal.aborted) {
24
+ // Exiting early if one of the signals
25
+ // is already aborted.
26
+ controller.abort(signal === null || signal === void 0 ? void 0 : signal.reason);
27
+ break;
28
+ }
29
+ // Listening for signals and removing the listeners
30
+ // when at least one symbol is aborted.
31
+ signal.addEventListener("abort", () => controller.abort(signal === null || signal === void 0 ? void 0 : signal.reason), {
32
+ signal: controller.signal,
33
+ });
34
+ }
35
+ return controller.signal;
36
+ }
37
+ exports.anySignal = anySignal;
@@ -1,24 +1,13 @@
1
- declare class FormDataRequestBody {
2
- private fd;
3
- private encoder;
4
- constructor(fd: any);
1
+ export declare type MaybePromise<T> = Promise<T> | T;
2
+ declare type FormDataRequest<Body> = {
3
+ body: Body;
4
+ headers: Record<string, string>;
5
+ };
6
+ export interface CrossPlatformFormData {
5
7
  setup(): Promise<void>;
6
- /**
7
- * @returns the multipart form data request
8
- */
9
- getBody(): Promise<any>;
10
- /**
11
- * @returns headers that need to be added to the multipart form data request
12
- */
13
- getHeaders(): Promise<Record<string, string>>;
14
- }
15
- /**
16
- * FormDataWrapper is a utility to make form data
17
- * requests across both Browser and Node.js runtimes.
18
- */
19
- export declare class FormDataWrapper {
20
- private fd;
21
- append(name: string, value: any): Promise<void>;
22
- getRequest(): FormDataRequestBody;
8
+ append(key: string, value: unknown): void;
9
+ appendFile(key: string, value: unknown, fileName?: string): Promise<void>;
10
+ getRequest(): MaybePromise<FormDataRequest<unknown>>;
23
11
  }
12
+ export declare function newFormData(): Promise<CrossPlatformFormData>;
24
13
  export {};
@@ -32,75 +32,108 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
32
32
  });
33
33
  };
34
34
  Object.defineProperty(exports, "__esModule", { value: true });
35
- exports.FormDataWrapper = void 0;
36
- const stream_1 = require("stream");
35
+ exports.newFormData = void 0;
37
36
  const runtime_1 = require("../runtime");
38
- class FormDataRequestBody {
39
- constructor(fd) {
40
- this.fd = fd;
41
- }
37
+ function newFormData() {
38
+ return __awaiter(this, void 0, void 0, function* () {
39
+ let formdata;
40
+ if (runtime_1.RUNTIME.type === "node" && runtime_1.RUNTIME.parsedVersion != null && runtime_1.RUNTIME.parsedVersion > 18) {
41
+ formdata = new Node19FormData();
42
+ }
43
+ else if (runtime_1.RUNTIME.type === "node") {
44
+ formdata = new Node16FormData();
45
+ }
46
+ else {
47
+ formdata = new WebFormData();
48
+ }
49
+ yield formdata.setup();
50
+ return formdata;
51
+ });
52
+ }
53
+ exports.newFormData = newFormData;
54
+ /**
55
+ * Form Data Implementation for Node.js 18+
56
+ */
57
+ class Node19FormData {
42
58
  setup() {
43
59
  return __awaiter(this, void 0, void 0, function* () {
44
- if (this.encoder == null && runtime_1.RUNTIME.type === "node") {
45
- this.encoder = new (yield Promise.resolve().then(() => __importStar(require("form-data-encoder")))).FormDataEncoder(this.fd);
46
- }
60
+ this.fd = new (yield Promise.resolve().then(() => __importStar(require("formdata-node")))).FormData();
47
61
  });
48
62
  }
49
- /**
50
- * @returns the multipart form data request
51
- */
52
- getBody() {
63
+ append(key, value) {
64
+ var _a;
65
+ (_a = this.fd) === null || _a === void 0 ? void 0 : _a.append(key, value);
66
+ }
67
+ appendFile(key, value, fileName) {
68
+ var _a;
53
69
  return __awaiter(this, void 0, void 0, function* () {
54
- if (runtime_1.RUNTIME.type !== "node") {
55
- return this.fd;
56
- }
57
- else {
58
- if (this.encoder == null) {
59
- yield this.setup();
60
- }
61
- return stream_1.Readable.from(this.encoder);
62
- }
70
+ (_a = this.fd) === null || _a === void 0 ? void 0 : _a.append(key, new (yield Promise.resolve().then(() => __importStar(require("buffer")))).Blob([value]), fileName);
71
+ });
72
+ }
73
+ getRequest() {
74
+ return __awaiter(this, void 0, void 0, function* () {
75
+ const encoder = new (yield Promise.resolve().then(() => __importStar(require("form-data-encoder")))).FormDataEncoder(this.fd);
76
+ return {
77
+ body: (yield Promise.resolve().then(() => __importStar(require("stream")))).Readable.from(encoder),
78
+ headers: encoder.headers,
79
+ };
80
+ });
81
+ }
82
+ }
83
+ /**
84
+ * Form Data Implementation for Node.js 16-18
85
+ */
86
+ class Node16FormData {
87
+ setup() {
88
+ return __awaiter(this, void 0, void 0, function* () {
89
+ this.fd = new (yield Promise.resolve().then(() => __importStar(require("form-data")))).default();
63
90
  });
64
91
  }
65
- /**
66
- * @returns headers that need to be added to the multipart form data request
67
- */
68
- getHeaders() {
92
+ append(key, value) {
93
+ var _a;
94
+ (_a = this.fd) === null || _a === void 0 ? void 0 : _a.append(key, value);
95
+ }
96
+ appendFile(key, value, fileName) {
97
+ var _a, _b;
69
98
  return __awaiter(this, void 0, void 0, function* () {
70
- if (runtime_1.RUNTIME.type !== "node") {
71
- return {};
99
+ if (fileName == null) {
100
+ (_a = this.fd) === null || _a === void 0 ? void 0 : _a.append(key, value);
72
101
  }
73
102
  else {
74
- if (this.encoder == null) {
75
- yield this.setup();
76
- }
77
- return {
78
- "Content-Length": this.encoder.length,
79
- };
103
+ (_b = this.fd) === null || _b === void 0 ? void 0 : _b.append(key, value, { filename: fileName });
80
104
  }
81
105
  });
82
106
  }
107
+ getRequest() {
108
+ return {
109
+ body: this.fd,
110
+ headers: this.fd ? this.fd.getHeaders() : {},
111
+ };
112
+ }
83
113
  }
84
114
  /**
85
- * FormDataWrapper is a utility to make form data
86
- * requests across both Browser and Node.js runtimes.
115
+ * Form Data Implementation for Web
87
116
  */
88
- class FormDataWrapper {
89
- append(name, value) {
117
+ class WebFormData {
118
+ setup() {
90
119
  return __awaiter(this, void 0, void 0, function* () {
91
- if (this.fd == null) {
92
- if (runtime_1.RUNTIME.type === "node") {
93
- this.fd = new (yield Promise.resolve().then(() => __importStar(require("formdata-node")))).FormData();
94
- }
95
- else {
96
- this.fd = new (yield Promise.resolve().then(() => __importStar(require("form-data")))).default();
97
- }
98
- }
99
- this.fd.append(name, value);
120
+ this.fd = new FormData();
121
+ });
122
+ }
123
+ append(key, value) {
124
+ var _a;
125
+ (_a = this.fd) === null || _a === void 0 ? void 0 : _a.append(key, value);
126
+ }
127
+ appendFile(key, value, fileName) {
128
+ var _a;
129
+ return __awaiter(this, void 0, void 0, function* () {
130
+ (_a = this.fd) === null || _a === void 0 ? void 0 : _a.append(key, new Blob([value]), fileName);
100
131
  });
101
132
  }
102
133
  getRequest() {
103
- return new FormDataRequestBody(this.fd);
134
+ return {
135
+ body: this.fd,
136
+ headers: {},
137
+ };
104
138
  }
105
139
  }
106
- exports.FormDataWrapper = FormDataWrapper;
@@ -5,4 +5,5 @@ export declare const RUNTIME: Runtime;
5
5
  export interface Runtime {
6
6
  type: "browser" | "web-worker" | "deno" | "bun" | "node" | "react-native" | "unknown" | "workerd";
7
7
  version?: string;
8
+ parsedVersion?: number;
8
9
  }
@@ -79,6 +79,7 @@ function evaluateRuntime() {
79
79
  return {
80
80
  type: "node",
81
81
  version: process.versions.node,
82
+ parsedVersion: Number(process.versions.node.split(".")[0]),
82
83
  };
83
84
  }
84
85
  if (isReactNative) {
@@ -1,12 +1,11 @@
1
1
  import { SchemaUtils } from "./builders";
2
- import { MaybePromise } from "./utils/MaybePromise";
3
2
  export declare type Schema<Raw = unknown, Parsed = unknown> = BaseSchema<Raw, Parsed> & SchemaUtils<Raw, Parsed>;
4
3
  export declare type inferRaw<S extends Schema> = S extends Schema<infer Raw, any> ? Raw : never;
5
4
  export declare type inferParsed<S extends Schema> = S extends Schema<any, infer Parsed> ? Parsed : never;
6
5
  export interface BaseSchema<Raw, Parsed> {
7
- parse: (raw: unknown, opts?: SchemaOptions) => MaybePromise<MaybeValid<Parsed>>;
8
- json: (parsed: unknown, opts?: SchemaOptions) => MaybePromise<MaybeValid<Raw>>;
9
- getType: () => SchemaType | Promise<SchemaType>;
6
+ parse: (raw: unknown, opts?: SchemaOptions) => MaybeValid<Parsed>;
7
+ json: (parsed: unknown, opts?: SchemaOptions) => MaybeValid<Raw>;
8
+ getType: () => SchemaType | SchemaType;
10
9
  }
11
10
  export declare const SchemaType: {
12
11
  readonly DATE: "date";
@@ -78,4 +77,8 @@ export interface SchemaOptions {
78
77
  * helpful for zurg's internal debug logging.
79
78
  */
80
79
  breadcrumbsPrefix?: string[];
80
+ /**
81
+ * whether to send 'null' for optional properties explicitly set to 'undefined'.
82
+ */
83
+ omitUndefined?: boolean;
81
84
  }
@@ -1,5 +1,5 @@
1
1
  import { BaseSchema, Schema } from "../../Schema";
2
- export declare type SchemaGetter<SchemaType extends Schema<any, any>> = () => SchemaType | Promise<SchemaType>;
2
+ export declare type SchemaGetter<SchemaType extends Schema<any, any>> = () => SchemaType;
3
3
  export declare function lazy<Raw, Parsed>(getter: SchemaGetter<Schema<Raw, Parsed>>): Schema<Raw, Parsed>;
4
4
  export declare function constructLazyBaseSchema<Raw, Parsed>(getter: SchemaGetter<Schema<Raw, Parsed>>): BaseSchema<Raw, Parsed>;
5
- export declare function getMemoizedSchema<SchemaType extends Schema<any, any>>(getter: SchemaGetter<SchemaType>): Promise<SchemaType>;
5
+ export declare function getMemoizedSchema<SchemaType extends Schema<any, any>>(getter: SchemaGetter<SchemaType>): SchemaType;
@@ -1,13 +1,4 @@
1
1
  "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
2
  Object.defineProperty(exports, "__esModule", { value: true });
12
3
  exports.getMemoizedSchema = exports.constructLazyBaseSchema = exports.lazy = void 0;
13
4
  const schema_utils_1 = require("../schema-utils");
@@ -18,19 +9,17 @@ function lazy(getter) {
18
9
  exports.lazy = lazy;
19
10
  function constructLazyBaseSchema(getter) {
20
11
  return {
21
- parse: (raw, opts) => __awaiter(this, void 0, void 0, function* () { return (yield getMemoizedSchema(getter)).parse(raw, opts); }),
22
- json: (parsed, opts) => __awaiter(this, void 0, void 0, function* () { return (yield getMemoizedSchema(getter)).json(parsed, opts); }),
23
- getType: () => __awaiter(this, void 0, void 0, function* () { return (yield getMemoizedSchema(getter)).getType(); }),
12
+ parse: (raw, opts) => getMemoizedSchema(getter).parse(raw, opts),
13
+ json: (parsed, opts) => getMemoizedSchema(getter).json(parsed, opts),
14
+ getType: () => getMemoizedSchema(getter).getType(),
24
15
  };
25
16
  }
26
17
  exports.constructLazyBaseSchema = constructLazyBaseSchema;
27
18
  function getMemoizedSchema(getter) {
28
- return __awaiter(this, void 0, void 0, function* () {
29
- const castedGetter = getter;
30
- if (castedGetter.__zurg_memoized == null) {
31
- castedGetter.__zurg_memoized = yield getter();
32
- }
33
- return castedGetter.__zurg_memoized;
34
- });
19
+ const castedGetter = getter;
20
+ if (castedGetter.__zurg_memoized == null) {
21
+ castedGetter.__zurg_memoized = getter();
22
+ }
23
+ return castedGetter.__zurg_memoized;
35
24
  }
36
25
  exports.getMemoizedSchema = getMemoizedSchema;
@@ -1,13 +1,4 @@
1
1
  "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
2
  Object.defineProperty(exports, "__esModule", { value: true });
12
3
  exports.lazyObject = void 0;
13
4
  const object_1 = require("../object");
@@ -15,7 +6,7 @@ const object_like_1 = require("../object-like");
15
6
  const schema_utils_1 = require("../schema-utils");
16
7
  const lazy_1 = require("./lazy");
17
8
  function lazyObject(getter) {
18
- const baseSchema = Object.assign(Object.assign({}, (0, lazy_1.constructLazyBaseSchema)(getter)), { _getRawProperties: () => __awaiter(this, void 0, void 0, function* () { return (yield (0, lazy_1.getMemoizedSchema)(getter))._getRawProperties(); }), _getParsedProperties: () => __awaiter(this, void 0, void 0, function* () { return (yield (0, lazy_1.getMemoizedSchema)(getter))._getParsedProperties(); }) });
9
+ const baseSchema = Object.assign(Object.assign({}, (0, lazy_1.constructLazyBaseSchema)(getter)), { _getRawProperties: () => (0, lazy_1.getMemoizedSchema)(getter)._getRawProperties(), _getParsedProperties: () => (0, lazy_1.getMemoizedSchema)(getter)._getParsedProperties() });
19
10
  return Object.assign(Object.assign(Object.assign(Object.assign({}, baseSchema), (0, schema_utils_1.getSchemaUtils)(baseSchema)), (0, object_like_1.getObjectLikeUtils)(baseSchema)), (0, object_1.getObjectUtils)(baseSchema));
20
11
  }
21
12
  exports.lazyObject = lazyObject;
@@ -1,13 +1,4 @@
1
1
  "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
2
  Object.defineProperty(exports, "__esModule", { value: true });
12
3
  exports.list = void 0;
13
4
  const Schema_1 = require("../../Schema");
@@ -16,11 +7,9 @@ const maybeSkipValidation_1 = require("../../utils/maybeSkipValidation");
16
7
  const schema_utils_1 = require("../schema-utils");
17
8
  function list(schema) {
18
9
  const baseSchema = {
19
- parse: (raw, opts) => __awaiter(this, void 0, void 0, function* () {
20
- return validateAndTransformArray(raw, (item, index) => {
21
- var _a;
22
- return schema.parse(item, Object.assign(Object.assign({}, opts), { breadcrumbsPrefix: [...((_a = opts === null || opts === void 0 ? void 0 : opts.breadcrumbsPrefix) !== null && _a !== void 0 ? _a : []), `[${index}]`] }));
23
- });
10
+ parse: (raw, opts) => validateAndTransformArray(raw, (item, index) => {
11
+ var _a;
12
+ return schema.parse(item, Object.assign(Object.assign({}, opts), { breadcrumbsPrefix: [...((_a = opts === null || opts === void 0 ? void 0 : opts.breadcrumbsPrefix) !== null && _a !== void 0 ? _a : []), `[${index}]`] }));
24
13
  }),
25
14
  json: (parsed, opts) => validateAndTransformArray(parsed, (item, index) => {
26
15
  var _a;
@@ -32,37 +21,35 @@ function list(schema) {
32
21
  }
33
22
  exports.list = list;
34
23
  function validateAndTransformArray(value, transformItem) {
35
- return __awaiter(this, void 0, void 0, function* () {
36
- if (!Array.isArray(value)) {
24
+ if (!Array.isArray(value)) {
25
+ return {
26
+ ok: false,
27
+ errors: [
28
+ {
29
+ message: (0, getErrorMessageForIncorrectType_1.getErrorMessageForIncorrectType)(value, "list"),
30
+ path: [],
31
+ },
32
+ ],
33
+ };
34
+ }
35
+ const maybeValidItems = value.map((item, index) => transformItem(item, index));
36
+ return maybeValidItems.reduce((acc, item) => {
37
+ if (acc.ok && item.ok) {
37
38
  return {
38
- ok: false,
39
- errors: [
40
- {
41
- message: (0, getErrorMessageForIncorrectType_1.getErrorMessageForIncorrectType)(value, "list"),
42
- path: [],
43
- },
44
- ],
39
+ ok: true,
40
+ value: [...acc.value, item.value],
45
41
  };
46
42
  }
47
- const maybeValidItems = yield Promise.all(value.map((item, index) => transformItem(item, index)));
48
- return maybeValidItems.reduce((acc, item) => {
49
- if (acc.ok && item.ok) {
50
- return {
51
- ok: true,
52
- value: [...acc.value, item.value],
53
- };
54
- }
55
- const errors = [];
56
- if (!acc.ok) {
57
- errors.push(...acc.errors);
58
- }
59
- if (!item.ok) {
60
- errors.push(...item.errors);
61
- }
62
- return {
63
- ok: false,
64
- errors,
65
- };
66
- }, { ok: true, value: [] });
67
- });
43
+ const errors = [];
44
+ if (!acc.ok) {
45
+ errors.push(...acc.errors);
46
+ }
47
+ if (!item.ok) {
48
+ errors.push(...item.errors);
49
+ }
50
+ return {
51
+ ok: false,
52
+ errors,
53
+ };
54
+ }, { ok: true, value: [] });
68
55
  }