@struct-ai/sdk 0.1.2 → 0.2.1

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 (177) hide show
  1. package/README.md +46 -3
  2. package/dist/commonjs/core.js +8 -1
  3. package/dist/commonjs/integrations/langchain-callback.js +40 -5
  4. package/dist/esm/core.js +8 -1
  5. package/dist/esm/integrations/langchain-callback.js +40 -5
  6. package/package.json +16 -13
  7. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/content-capture.d.ts +0 -10
  8. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/context.d.ts +0 -30
  9. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/core.d.ts +0 -120
  10. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/events.d.ts +0 -12
  11. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/index.d.ts +0 -6
  12. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/integrations/anthropic-content.d.ts +0 -24
  13. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/integrations/anthropic.d.ts +0 -34
  14. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/integrations/index.d.ts +0 -5
  15. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/integrations/langchain-callback.d.ts +0 -134
  16. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/integrations/langchain-content.d.ts +0 -35
  17. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/integrations/langchain.d.ts +0 -11
  18. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/package.json +0 -3
  19. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/semconv.d.ts +0 -54
  20. package/dist/node_modules/@struct-ai/sdk/dist/commonjs/truncation.d.ts +0 -10
  21. package/dist/node_modules/@struct-ai/sdk/dist/esm/content-capture.d.ts +0 -10
  22. package/dist/node_modules/@struct-ai/sdk/dist/esm/context.d.ts +0 -30
  23. package/dist/node_modules/@struct-ai/sdk/dist/esm/core.d.ts +0 -120
  24. package/dist/node_modules/@struct-ai/sdk/dist/esm/events.d.ts +0 -12
  25. package/dist/node_modules/@struct-ai/sdk/dist/esm/index.d.ts +0 -6
  26. package/dist/node_modules/@struct-ai/sdk/dist/esm/integrations/anthropic-content.d.ts +0 -24
  27. package/dist/node_modules/@struct-ai/sdk/dist/esm/integrations/anthropic.d.ts +0 -34
  28. package/dist/node_modules/@struct-ai/sdk/dist/esm/integrations/index.d.ts +0 -5
  29. package/dist/node_modules/@struct-ai/sdk/dist/esm/integrations/langchain-callback.d.ts +0 -134
  30. package/dist/node_modules/@struct-ai/sdk/dist/esm/integrations/langchain-content.d.ts +0 -35
  31. package/dist/node_modules/@struct-ai/sdk/dist/esm/integrations/langchain.d.ts +0 -11
  32. package/dist/node_modules/@struct-ai/sdk/dist/esm/package.json +0 -3
  33. package/dist/node_modules/@struct-ai/sdk/dist/esm/semconv.d.ts +0 -54
  34. package/dist/node_modules/@struct-ai/sdk/dist/esm/truncation.d.ts +0 -10
  35. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/dist/commonjs/package.json +0 -3
  36. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/dist/esm/package.json +0 -3
  37. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/package.json +0 -100
  38. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/package.json +0 -103
  39. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/anthropic/package.json +0 -118
  40. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/package.json +0 -916
  41. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/langgraph/package.json +0 -188
  42. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/api/package.json +0 -96
  43. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/api-logs/package.json +0 -91
  44. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/core/package.json +0 -96
  45. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/exporter-logs-otlp-proto/package.json +0 -108
  46. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/exporter-trace-otlp-proto/package.json +0 -105
  47. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/resources/package.json +0 -100
  48. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/sdk-logs/package.json +0 -109
  49. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/sdk-trace-base/package.json +0 -100
  50. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/sdk-trace-node/package.json +0 -76
  51. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/package.json +0 -140
  52. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/nock/package.json +0 -89
  53. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/tshy/package.json +0 -81
  54. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/typescript/package.json +0 -120
  55. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/node_modules/vitest/package.json +0 -239
  56. package/dist/node_modules/@struct-ai/sdk/dist/node_modules/@struct-ai/sdk/package.json +0 -100
  57. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/core.d.ts +0 -244
  58. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/error.d.ts +0 -54
  59. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/index.d.ts +0 -188
  60. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/package.json +0 -103
  61. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/pagination.d.ts +0 -26
  62. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/resource.d.ts +0 -6
  63. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/streaming.d.ts +0 -41
  64. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/uploads.d.ts +0 -75
  65. package/dist/node_modules/@struct-ai/sdk/node_modules/@anthropic-ai/sdk/version.d.ts +0 -2
  66. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/anthropic/experimental.d.ts +0 -1
  67. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/anthropic/index.d.ts +0 -1
  68. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/anthropic/package.json +0 -118
  69. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/agents.d.ts +0 -1
  70. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/caches.d.ts +0 -1
  71. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/chat_history.d.ts +0 -1
  72. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/context.d.ts +0 -1
  73. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/documents.d.ts +0 -1
  74. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/embeddings.d.ts +0 -1
  75. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/example_selectors.d.ts +0 -1
  76. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/index.d.ts +0 -1
  77. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/indexing.d.ts +0 -1
  78. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/load.d.ts +0 -1
  79. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/memory.d.ts +0 -1
  80. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/messages.d.ts +0 -1
  81. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/output_parsers.d.ts +0 -1
  82. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/outputs.d.ts +0 -1
  83. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/package.json +0 -916
  84. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/prompt_values.d.ts +0 -1
  85. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/prompts.d.ts +0 -1
  86. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/retrievers.d.ts +0 -1
  87. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/runnables.d.ts +0 -1
  88. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/singletons.d.ts +0 -1
  89. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/stores.d.ts +0 -1
  90. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/structured_query.d.ts +0 -1
  91. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/tools.d.ts +0 -1
  92. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/core/vectorstores.d.ts +0 -1
  93. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/langgraph/index.d.ts +0 -1
  94. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/langgraph/package.json +0 -188
  95. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/langgraph/prebuilt.d.ts +0 -1
  96. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/langgraph/pregel.d.ts +0 -1
  97. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/langgraph/remote.d.ts +0 -1
  98. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/langgraph/web.d.ts +0 -1
  99. package/dist/node_modules/@struct-ai/sdk/node_modules/@langchain/langgraph/zod.d.ts +0 -1
  100. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/api/package.json +0 -96
  101. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/api-logs/package.json +0 -91
  102. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/core/package.json +0 -96
  103. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/exporter-logs-otlp-proto/package.json +0 -108
  104. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/exporter-trace-otlp-proto/package.json +0 -105
  105. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/resources/package.json +0 -100
  106. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/sdk-logs/package.json +0 -109
  107. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/sdk-trace-base/package.json +0 -100
  108. package/dist/node_modules/@struct-ai/sdk/node_modules/@opentelemetry/sdk-trace-node/package.json +0 -76
  109. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/assert.d.ts +0 -1062
  110. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/async_hooks.d.ts +0 -605
  111. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/buffer.buffer.d.ts +0 -471
  112. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/buffer.d.ts +0 -1936
  113. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/child_process.d.ts +0 -1475
  114. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/cluster.d.ts +0 -577
  115. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/console.d.ts +0 -452
  116. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/constants.d.ts +0 -21
  117. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/crypto.d.ts +0 -4590
  118. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/dgram.d.ts +0 -597
  119. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/diagnostics_channel.d.ts +0 -578
  120. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/dns.d.ts +0 -871
  121. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/domain.d.ts +0 -170
  122. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/events.d.ts +0 -977
  123. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/fs.d.ts +0 -4375
  124. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/globals.d.ts +0 -172
  125. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/globals.typedarray.d.ts +0 -38
  126. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/http.d.ts +0 -2049
  127. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/http2.d.ts +0 -2631
  128. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/https.d.ts +0 -578
  129. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/index.d.ts +0 -93
  130. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/inspector.generated.d.ts +0 -3966
  131. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/module.d.ts +0 -539
  132. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/net.d.ts +0 -1031
  133. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/os.d.ts +0 -506
  134. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/package.json +0 -140
  135. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/path.d.ts +0 -200
  136. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/perf_hooks.d.ts +0 -961
  137. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/process.d.ts +0 -1961
  138. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/punycode.d.ts +0 -117
  139. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/querystring.d.ts +0 -152
  140. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/readline.d.ts +0 -589
  141. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/repl.d.ts +0 -430
  142. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/sea.d.ts +0 -153
  143. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/stream.d.ts +0 -1698
  144. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/string_decoder.d.ts +0 -67
  145. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/test.d.ts +0 -1787
  146. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/timers.d.ts +0 -286
  147. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/tls.d.ts +0 -1259
  148. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/trace_events.d.ts +0 -197
  149. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/tty.d.ts +0 -208
  150. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/url.d.ts +0 -964
  151. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/util.d.ts +0 -2331
  152. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/v8.d.ts +0 -809
  153. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/vm.d.ts +0 -1001
  154. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/wasi.d.ts +0 -181
  155. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/worker_threads.d.ts +0 -715
  156. package/dist/node_modules/@struct-ai/sdk/node_modules/@types/node/zlib.d.ts +0 -598
  157. package/dist/node_modules/@struct-ai/sdk/node_modules/nock/package.json +0 -89
  158. package/dist/node_modules/@struct-ai/sdk/node_modules/tshy/package.json +0 -81
  159. package/dist/node_modules/@struct-ai/sdk/node_modules/typescript/package.json +0 -120
  160. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/config.d.ts +0 -3
  161. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/coverage.d.ts +0 -1
  162. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/environments.d.ts +0 -1
  163. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/globals.d.ts +0 -22
  164. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/import-meta.d.ts +0 -5
  165. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/importMeta.d.ts +0 -4
  166. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/jsdom.d.ts +0 -6
  167. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/mocker.d.ts +0 -1
  168. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/node.d.ts +0 -1
  169. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/optional-runtime-types.d.ts +0 -6
  170. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/optional-types.d.ts +0 -7
  171. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/package.json +0 -239
  172. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/reporters.d.ts +0 -1
  173. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/runners.d.ts +0 -1
  174. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/snapshot.d.ts +0 -1
  175. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/suite.d.ts +0 -1
  176. package/dist/node_modules/@struct-ai/sdk/node_modules/vitest/worker.d.ts +0 -1
  177. package/dist/node_modules/@struct-ai/sdk/package.json +0 -100
@@ -1,539 +0,0 @@
1
- /**
2
- * @since v0.3.7
3
- */
4
- declare module "module" {
5
- import { URL } from "node:url";
6
- import { MessagePort } from "node:worker_threads";
7
- class Module {
8
- constructor(id: string, parent?: Module);
9
- }
10
- interface Module extends NodeJS.Module {}
11
- namespace Module {
12
- export { Module };
13
- }
14
- namespace Module {
15
- /**
16
- * A list of the names of all modules provided by Node.js. Can be used to verify
17
- * if a module is maintained by a third party or not.
18
- *
19
- * Note: the list doesn't contain prefix-only modules like `node:test`.
20
- * @since v9.3.0, v8.10.0, v6.13.0
21
- */
22
- const builtinModules: readonly string[];
23
- /**
24
- * @since v12.2.0
25
- * @param path Filename to be used to construct the require
26
- * function. Must be a file URL object, file URL string, or absolute path
27
- * string.
28
- */
29
- function createRequire(path: string | URL): NodeJS.Require;
30
- /**
31
- * @since v18.6.0, v16.17.0
32
- */
33
- function isBuiltin(moduleName: string): boolean;
34
- interface RegisterOptions<Data> {
35
- /**
36
- * If you want to resolve `specifier` relative to a
37
- * base URL, such as `import.meta.url`, you can pass that URL here. This
38
- * property is ignored if the `parentURL` is supplied as the second argument.
39
- * @default 'data:'
40
- */
41
- parentURL?: string | URL | undefined;
42
- /**
43
- * Any arbitrary, cloneable JavaScript value to pass into the
44
- * {@link initialize} hook.
45
- */
46
- data?: Data | undefined;
47
- /**
48
- * [Transferable objects](https://nodejs.org/docs/latest-v20.x/api/worker_threads.html#portpostmessagevalue-transferlist)
49
- * to be passed into the `initialize` hook.
50
- */
51
- transferList?: any[] | undefined;
52
- }
53
- /* eslint-disable @definitelytyped/no-unnecessary-generics */
54
- /**
55
- * Register a module that exports hooks that customize Node.js module
56
- * resolution and loading behavior. See
57
- * [Customization hooks](https://nodejs.org/docs/latest-v20.x/api/module.html#customization-hooks).
58
- * @since v20.6.0, v18.19.0
59
- * @param specifier Customization hooks to be registered; this should be
60
- * the same string that would be passed to `import()`, except that if it is
61
- * relative, it is resolved relative to `parentURL`.
62
- * @param parentURL f you want to resolve `specifier` relative to a base
63
- * URL, such as `import.meta.url`, you can pass that URL here.
64
- */
65
- function register<Data = any>(
66
- specifier: string | URL,
67
- parentURL?: string | URL,
68
- options?: RegisterOptions<Data>,
69
- ): void;
70
- function register<Data = any>(specifier: string | URL, options?: RegisterOptions<Data>): void;
71
- /* eslint-enable @definitelytyped/no-unnecessary-generics */
72
- /**
73
- * The `module.syncBuiltinESMExports()` method updates all the live bindings for
74
- * builtin `ES Modules` to match the properties of the `CommonJS` exports. It
75
- * does not add or remove exported names from the `ES Modules`.
76
- *
77
- * ```js
78
- * import fs from 'node:fs';
79
- * import assert from 'node:assert';
80
- * import { syncBuiltinESMExports } from 'node:module';
81
- *
82
- * fs.readFile = newAPI;
83
- *
84
- * delete fs.readFileSync;
85
- *
86
- * function newAPI() {
87
- * // ...
88
- * }
89
- *
90
- * fs.newAPI = newAPI;
91
- *
92
- * syncBuiltinESMExports();
93
- *
94
- * import('node:fs').then((esmFS) => {
95
- * // It syncs the existing readFile property with the new value
96
- * assert.strictEqual(esmFS.readFile, newAPI);
97
- * // readFileSync has been deleted from the required fs
98
- * assert.strictEqual('readFileSync' in fs, false);
99
- * // syncBuiltinESMExports() does not remove readFileSync from esmFS
100
- * assert.strictEqual('readFileSync' in esmFS, true);
101
- * // syncBuiltinESMExports() does not add names
102
- * assert.strictEqual(esmFS.newAPI, undefined);
103
- * });
104
- * ```
105
- * @since v12.12.0
106
- */
107
- function syncBuiltinESMExports(): void;
108
- /** @deprecated Use `ImportAttributes` instead */
109
- interface ImportAssertions extends ImportAttributes {}
110
- interface ImportAttributes extends NodeJS.Dict<string> {
111
- type?: string | undefined;
112
- }
113
- type ModuleFormat = "builtin" | "commonjs" | "json" | "module" | "wasm";
114
- type ModuleSource = string | ArrayBuffer | NodeJS.TypedArray;
115
- /**
116
- * The `initialize` hook provides a way to define a custom function that runs in
117
- * the hooks thread when the hooks module is initialized. Initialization happens
118
- * when the hooks module is registered via {@link register}.
119
- *
120
- * This hook can receive data from a {@link register} invocation, including
121
- * ports and other transferable objects. The return value of `initialize` can be a
122
- * `Promise`, in which case it will be awaited before the main application thread
123
- * execution resumes.
124
- */
125
- type InitializeHook<Data = any> = (data: Data) => void | Promise<void>;
126
- interface ResolveHookContext {
127
- /**
128
- * Export conditions of the relevant `package.json`
129
- */
130
- conditions: string[];
131
- /**
132
- * @deprecated Use `importAttributes` instead
133
- */
134
- importAssertions: ImportAttributes;
135
- /**
136
- * An object whose key-value pairs represent the assertions for the module to import
137
- */
138
- importAttributes: ImportAttributes;
139
- /**
140
- * The module importing this one, or undefined if this is the Node.js entry point
141
- */
142
- parentURL: string | undefined;
143
- }
144
- interface ResolveFnOutput {
145
- /**
146
- * A hint to the load hook (it might be ignored)
147
- */
148
- format?: ModuleFormat | null | undefined;
149
- /**
150
- * @deprecated Use `importAttributes` instead
151
- */
152
- importAssertions?: ImportAttributes | undefined;
153
- /**
154
- * The import attributes to use when caching the module (optional; if excluded the input will be used)
155
- */
156
- importAttributes?: ImportAttributes | undefined;
157
- /**
158
- * A signal that this hook intends to terminate the chain of `resolve` hooks.
159
- * @default false
160
- */
161
- shortCircuit?: boolean | undefined;
162
- /**
163
- * The absolute URL to which this input resolves
164
- */
165
- url: string;
166
- }
167
- /**
168
- * The `resolve` hook chain is responsible for telling Node.js where to find and
169
- * how to cache a given `import` statement or expression, or `require` call. It can
170
- * optionally return a format (such as `'module'`) as a hint to the `load` hook. If
171
- * a format is specified, the `load` hook is ultimately responsible for providing
172
- * the final `format` value (and it is free to ignore the hint provided by
173
- * `resolve`); if `resolve` provides a `format`, a custom `load` hook is required
174
- * even if only to pass the value to the Node.js default `load` hook.
175
- */
176
- type ResolveHook = (
177
- specifier: string,
178
- context: ResolveHookContext,
179
- nextResolve: (
180
- specifier: string,
181
- context?: Partial<ResolveHookContext>,
182
- ) => ResolveFnOutput | Promise<ResolveFnOutput>,
183
- ) => ResolveFnOutput | Promise<ResolveFnOutput>;
184
- interface LoadHookContext {
185
- /**
186
- * Export conditions of the relevant `package.json`
187
- */
188
- conditions: string[];
189
- /**
190
- * The format optionally supplied by the `resolve` hook chain
191
- */
192
- format: ModuleFormat | null | undefined;
193
- /**
194
- * @deprecated Use `importAttributes` instead
195
- */
196
- importAssertions: ImportAttributes;
197
- /**
198
- * An object whose key-value pairs represent the assertions for the module to import
199
- */
200
- importAttributes: ImportAttributes;
201
- }
202
- interface LoadFnOutput {
203
- format: string | null | undefined;
204
- /**
205
- * A signal that this hook intends to terminate the chain of `resolve` hooks.
206
- * @default false
207
- */
208
- shortCircuit?: boolean | undefined;
209
- /**
210
- * The source for Node.js to evaluate
211
- */
212
- source?: ModuleSource | undefined;
213
- }
214
- /**
215
- * The `load` hook provides a way to define a custom method of determining how a
216
- * URL should be interpreted, retrieved, and parsed. It is also in charge of
217
- * validating the import attributes.
218
- */
219
- type LoadHook = (
220
- url: string,
221
- context: LoadHookContext,
222
- nextLoad: (
223
- url: string,
224
- context?: Partial<LoadHookContext>,
225
- ) => LoadFnOutput | Promise<LoadFnOutput>,
226
- ) => LoadFnOutput | Promise<LoadFnOutput>;
227
- interface GlobalPreloadContext {
228
- port: MessagePort;
229
- }
230
- /**
231
- * Sometimes it might be necessary to run some code inside of the same global
232
- * scope that the application runs in. This hook allows the return of a string
233
- * that is run as a sloppy-mode script on startup.
234
- * @deprecated This hook will be removed in a future version. Use
235
- * `initialize` instead. When a hooks module has an `initialize` export,
236
- * `globalPreload` will be ignored.
237
- */
238
- type GlobalPreloadHook = (context: GlobalPreloadContext) => string;
239
- /**
240
- * `path` is the resolved path for the file for which a corresponding source map
241
- * should be fetched.
242
- * @since v13.7.0, v12.17.0
243
- * @return Returns `module.SourceMap` if a source map is found, `undefined` otherwise.
244
- */
245
- function findSourceMap(path: string): SourceMap | undefined;
246
- interface SourceMapConstructorOptions {
247
- /**
248
- * @since v20.5.0
249
- */
250
- lineLengths?: readonly number[] | undefined;
251
- }
252
- interface SourceMapPayload {
253
- file: string;
254
- version: number;
255
- sources: string[];
256
- sourcesContent: string[];
257
- names: string[];
258
- mappings: string;
259
- sourceRoot: string;
260
- }
261
- interface SourceMapping {
262
- generatedLine: number;
263
- generatedColumn: number;
264
- originalSource: string;
265
- originalLine: number;
266
- originalColumn: number;
267
- }
268
- interface SourceOrigin {
269
- /**
270
- * The name of the range in the source map, if one was provided
271
- */
272
- name: string | undefined;
273
- /**
274
- * The file name of the original source, as reported in the SourceMap
275
- */
276
- fileName: string;
277
- /**
278
- * The 1-indexed lineNumber of the corresponding call site in the original source
279
- */
280
- lineNumber: number;
281
- /**
282
- * The 1-indexed columnNumber of the corresponding call site in the original source
283
- */
284
- columnNumber: number;
285
- }
286
- /**
287
- * @since v13.7.0, v12.17.0
288
- */
289
- class SourceMap {
290
- constructor(payload: SourceMapPayload, options?: SourceMapConstructorOptions);
291
- /**
292
- * Getter for the payload used to construct the `SourceMap` instance.
293
- */
294
- readonly payload: SourceMapPayload;
295
- /**
296
- * Given a line offset and column offset in the generated source
297
- * file, returns an object representing the SourceMap range in the
298
- * original file if found, or an empty object if not.
299
- *
300
- * The object returned contains the following keys:
301
- *
302
- * The returned value represents the raw range as it appears in the
303
- * SourceMap, based on zero-indexed offsets, _not_ 1-indexed line and
304
- * column numbers as they appear in Error messages and CallSite
305
- * objects.
306
- *
307
- * To get the corresponding 1-indexed line and column numbers from a
308
- * lineNumber and columnNumber as they are reported by Error stacks
309
- * and CallSite objects, use `sourceMap.findOrigin(lineNumber, columnNumber)`
310
- * @param lineOffset The zero-indexed line number offset in the generated source
311
- * @param columnOffset The zero-indexed column number offset in the generated source
312
- */
313
- findEntry(lineOffset: number, columnOffset: number): SourceMapping | {};
314
- /**
315
- * Given a 1-indexed `lineNumber` and `columnNumber` from a call site in the generated source,
316
- * find the corresponding call site location in the original source.
317
- *
318
- * If the `lineNumber` and `columnNumber` provided are not found in any source map,
319
- * then an empty object is returned.
320
- * @param lineNumber The 1-indexed line number of the call site in the generated source
321
- * @param columnNumber The 1-indexed column number of the call site in the generated source
322
- */
323
- findOrigin(lineNumber: number, columnNumber: number): SourceOrigin | {};
324
- }
325
- function runMain(main?: string): void;
326
- function wrap(script: string): string;
327
- }
328
- global {
329
- interface ImportMeta {
330
- /**
331
- * The directory name of the current module. This is the same as the `path.dirname()` of the `import.meta.filename`.
332
- * **Caveat:** only present on `file:` modules.
333
- */
334
- dirname: string;
335
- /**
336
- * The full absolute path and filename of the current module, with symlinks resolved.
337
- * This is the same as the `url.fileURLToPath()` of the `import.meta.url`.
338
- * **Caveat:** only local modules support this property. Modules not using the `file:` protocol will not provide it.
339
- */
340
- filename: string;
341
- /**
342
- * The absolute `file:` URL of the module.
343
- */
344
- url: string;
345
- /**
346
- * Provides a module-relative resolution function scoped to each module, returning
347
- * the URL string.
348
- *
349
- * Second `parent` parameter is only used when the `--experimental-import-meta-resolve`
350
- * command flag enabled.
351
- *
352
- * @since v20.6.0
353
- *
354
- * @param specifier The module specifier to resolve relative to `parent`.
355
- * @param parent The absolute parent module URL to resolve from.
356
- * @returns The absolute (`file:`) URL string for the resolved module.
357
- */
358
- resolve(specifier: string, parent?: string | URL | undefined): string;
359
- }
360
- namespace NodeJS {
361
- interface Module {
362
- /**
363
- * The module objects required for the first time by this one.
364
- * @since v0.1.16
365
- */
366
- children: Module[];
367
- /**
368
- * The `module.exports` object is created by the `Module` system. Sometimes this is
369
- * not acceptable; many want their module to be an instance of some class. To do
370
- * this, assign the desired export object to `module.exports`.
371
- * @since v0.1.16
372
- */
373
- exports: any;
374
- /**
375
- * The fully resolved filename of the module.
376
- * @since v0.1.16
377
- */
378
- filename: string;
379
- /**
380
- * The identifier for the module. Typically this is the fully resolved
381
- * filename.
382
- * @since v0.1.16
383
- */
384
- id: string;
385
- /**
386
- * `true` if the module is running during the Node.js preload
387
- * phase.
388
- * @since v15.4.0, v14.17.0
389
- */
390
- isPreloading: boolean;
391
- /**
392
- * Whether or not the module is done loading, or is in the process of
393
- * loading.
394
- * @since v0.1.16
395
- */
396
- loaded: boolean;
397
- /**
398
- * The module that first required this one, or `null` if the current module is the
399
- * entry point of the current process, or `undefined` if the module was loaded by
400
- * something that is not a CommonJS module (e.g. REPL or `import`).
401
- * @since v0.1.16
402
- * @deprecated Please use `require.main` and `module.children` instead.
403
- */
404
- parent: Module | null | undefined;
405
- /**
406
- * The directory name of the module. This is usually the same as the
407
- * `path.dirname()` of the `module.id`.
408
- * @since v11.14.0
409
- */
410
- path: string;
411
- /**
412
- * The search paths for the module.
413
- * @since v0.4.0
414
- */
415
- paths: string[];
416
- /**
417
- * The `module.require()` method provides a way to load a module as if
418
- * `require()` was called from the original module.
419
- * @since v0.5.1
420
- */
421
- require(id: string): any;
422
- }
423
- interface Require {
424
- /**
425
- * Used to import modules, `JSON`, and local files.
426
- * @since v0.1.13
427
- */
428
- (id: string): any;
429
- /**
430
- * Modules are cached in this object when they are required. By deleting a key
431
- * value from this object, the next `require` will reload the module.
432
- * This does not apply to
433
- * [native addons](https://nodejs.org/docs/latest-v20.x/api/addons.html),
434
- * for which reloading will result in an error.
435
- * @since v0.3.0
436
- */
437
- cache: Dict<Module>;
438
- /**
439
- * Instruct `require` on how to handle certain file extensions.
440
- * @since v0.3.0
441
- * @deprecated
442
- */
443
- extensions: RequireExtensions;
444
- /**
445
- * The `Module` object representing the entry script loaded when the Node.js
446
- * process launched, or `undefined` if the entry point of the program is not a
447
- * CommonJS module.
448
- * @since v0.1.17
449
- */
450
- main: Module | undefined;
451
- /**
452
- * @since v0.3.0
453
- */
454
- resolve: RequireResolve;
455
- }
456
- /** @deprecated */
457
- interface RequireExtensions extends Dict<(module: Module, filename: string) => any> {
458
- ".js": (module: Module, filename: string) => any;
459
- ".json": (module: Module, filename: string) => any;
460
- ".node": (module: Module, filename: string) => any;
461
- }
462
- interface RequireResolveOptions {
463
- /**
464
- * Paths to resolve module location from. If present, these
465
- * paths are used instead of the default resolution paths, with the exception
466
- * of
467
- * [GLOBAL\_FOLDERS](https://nodejs.org/docs/latest-v20.x/api/modules.html#loading-from-the-global-folders)
468
- * like `$HOME/.node_modules`, which are
469
- * always included. Each of these paths is used as a starting point for
470
- * the module resolution algorithm, meaning that the `node_modules` hierarchy
471
- * is checked from this location.
472
- * @since v8.9.0
473
- */
474
- paths?: string[] | undefined;
475
- }
476
- interface RequireResolve {
477
- /**
478
- * Use the internal `require()` machinery to look up the location of a module,
479
- * but rather than loading the module, just return the resolved filename.
480
- *
481
- * If the module can not be found, a `MODULE_NOT_FOUND` error is thrown.
482
- * @since v0.3.0
483
- * @param request The module path to resolve.
484
- */
485
- (id: string, options?: RequireResolveOptions): string;
486
- /**
487
- * Returns an array containing the paths searched during resolution of `request` or
488
- * `null` if the `request` string references a core module, for example `http` or
489
- * `fs`.
490
- * @since v8.9.0
491
- * @param request The module path whose lookup paths are being retrieved.
492
- */
493
- paths(request: string): string[] | null;
494
- }
495
- }
496
- /**
497
- * The directory name of the current module. This is the same as the
498
- * `path.dirname()` of the `__filename`.
499
- * @since v0.1.27
500
- */
501
- var __dirname: string;
502
- /**
503
- * The file name of the current module. This is the current module file's absolute
504
- * path with symlinks resolved.
505
- *
506
- * For a main program this is not necessarily the same as the file name used in the
507
- * command line.
508
- * @since v0.0.1
509
- */
510
- var __filename: string;
511
- /**
512
- * The `exports` variable is available within a module's file-level scope, and is
513
- * assigned the value of `module.exports` before the module is evaluated.
514
- * @since v0.1.16
515
- */
516
- var exports: NodeJS.Module["exports"];
517
- /**
518
- * A reference to the current module.
519
- * @since v0.1.16
520
- */
521
- var module: NodeJS.Module;
522
- /**
523
- * @since v0.1.13
524
- */
525
- var require: NodeJS.Require;
526
- // Global-scope aliases for backwards compatibility with @types/node <13.0.x
527
- /** @deprecated Use `NodeJS.Module` instead. */
528
- interface NodeModule extends NodeJS.Module {}
529
- /** @deprecated Use `NodeJS.Require` instead. */
530
- interface NodeRequire extends NodeJS.Require {}
531
- /** @deprecated Use `NodeJS.RequireResolve` instead. */
532
- interface RequireResolve extends NodeJS.RequireResolve {}
533
- }
534
- export = Module;
535
- }
536
- declare module "node:module" {
537
- import module = require("module");
538
- export = module;
539
- }