@intuned/runtime-dev 1.3.18-interface.9 → 1.3.21-dev.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (212) hide show
  1. package/.babelrc +27 -0
  2. package/.eslintignore +10 -0
  3. package/.eslintrc.js +39 -0
  4. package/CHANGELOG.md +2 -1
  5. package/InterfaceTemplate/__utils.ts +63 -0
  6. package/InterfaceTemplate/index.playwright.ts +6 -0
  7. package/bin/intuned +20 -2
  8. package/dist/commands/api/run.d.ts +6 -0
  9. package/dist/commands/api/run.js +119 -0
  10. package/dist/commands/auth-sessions/load.d.ts +2 -0
  11. package/dist/commands/auth-sessions/load.js +38 -0
  12. package/dist/commands/auth-sessions/run-check.d.ts +2 -0
  13. package/dist/commands/auth-sessions/run-check.js +83 -0
  14. package/dist/commands/auth-sessions/run-create.d.ts +2 -0
  15. package/dist/commands/auth-sessions/run-create.js +85 -0
  16. package/dist/commands/browser/save-state.d.ts +2 -0
  17. package/dist/commands/browser/save-state.js +17 -0
  18. package/dist/commands/browser/start-browser.d.ts +2 -0
  19. package/dist/commands/browser/start-browser.js +14 -0
  20. package/dist/commands/build.d.ts +1 -0
  21. package/dist/commands/build.js +83 -0
  22. package/dist/commands/common/browserUtils.d.ts +14 -0
  23. package/dist/commands/common/browserUtils.js +66 -0
  24. package/dist/commands/common/getFirstLineNumber.d.ts +9 -0
  25. package/dist/commands/common/getFirstLineNumber.js +101 -0
  26. package/dist/commands/common/getFirstLineNumber.test.js +227 -0
  27. package/dist/commands/common/projectExclusions.d.ts +2 -0
  28. package/dist/commands/common/projectExclusions.js +8 -0
  29. package/dist/commands/common/sendMessageToClient.d.ts +1 -0
  30. package/dist/commands/common/sendMessageToClient.js +10 -0
  31. package/dist/commands/common/tsNodeImport.d.ts +2 -5
  32. package/dist/commands/common/tsNodeImport.js +15 -56
  33. package/dist/commands/common/utils/fileUtils.d.ts +6 -0
  34. package/dist/commands/common/utils/fileUtils.js +32 -0
  35. package/dist/commands/common/utils/interfaceClient.d.ts +31 -0
  36. package/dist/commands/common/utils/interfaceClient.js +98 -0
  37. package/dist/commands/common/utils/settings.d.ts +2 -0
  38. package/dist/commands/common/utils/settings.js +31 -0
  39. package/dist/commands/common/utils/template.d.ts +2 -0
  40. package/dist/commands/common/utils/template.js +30 -0
  41. package/dist/commands/get-headless-user-agent.d.ts +1 -0
  42. package/dist/commands/get-headless-user-agent.js +18 -0
  43. package/dist/commands/interface/run.d.ts +1 -3
  44. package/dist/commands/interface/run.js +139 -2047
  45. package/dist/commands/ts-check.d.ts +2 -0
  46. package/dist/commands/ts-check.js +55 -0
  47. package/dist/common/Logger/Logger/index.d.ts +12 -0
  48. package/dist/common/Logger/Logger/index.js +60 -0
  49. package/dist/common/Logger/Logger/types.d.ts +8 -0
  50. package/dist/common/Logger/Logger/types.js +5 -0
  51. package/dist/common/Logger/index.d.ts +12 -0
  52. package/dist/common/Logger/index.js +60 -0
  53. package/dist/common/Logger/types.d.ts +8 -0
  54. package/dist/common/Logger/types.js +5 -0
  55. package/dist/common/asyncLocalStorage/index.d.ts +8 -9
  56. package/dist/common/asyncLocalStorage/index.js +9 -34
  57. package/dist/common/backendFunctions/getAuthSessionParameters.d.ts +1 -0
  58. package/dist/common/backendFunctions/getAuthSessionParameters.js +38 -0
  59. package/dist/common/binStartupScript.d.ts +1 -2
  60. package/dist/common/binStartupScript.js +25 -132
  61. package/dist/common/browserTabs.d.ts +72 -0
  62. package/dist/common/browserTabs.js +74 -0
  63. package/dist/common/cleanEnvironmentVariables.d.ts +1 -3
  64. package/dist/common/cleanEnvironmentVariables.js +7 -30
  65. package/dist/common/constants.d.ts +11 -13
  66. package/dist/common/constants.js +15 -58
  67. package/dist/common/contextStorageStateHelpers.d.ts +6 -8
  68. package/dist/common/contextStorageStateHelpers.js +26 -48
  69. package/dist/common/env.d.ts +6 -0
  70. package/dist/common/env.js +17 -0
  71. package/dist/common/extension/extensionsHelpers.d.ts +11 -0
  72. package/dist/common/extension/extensionsHelpers.js +147 -0
  73. package/dist/common/extension/intunedExtensionServer.d.ts +24 -0
  74. package/dist/common/extension/intunedExtensionServer.js +178 -0
  75. package/dist/common/extension/types.d.ts +219 -0
  76. package/dist/common/extension/types.js +51 -0
  77. package/dist/common/formatZodError.d.ts +2 -0
  78. package/dist/{chunk-NDMVGENG.mjs → common/formatZodError.js} +9 -9
  79. package/dist/common/intunedJson.d.ts +249 -0
  80. package/dist/common/intunedJson.js +155 -0
  81. package/dist/common/jwtTokenManager.d.ts +4 -6
  82. package/dist/common/jwtTokenManager.js +40 -108
  83. package/dist/common/launchBrowser.d.ts +43 -0
  84. package/dist/common/launchBrowser.js +301 -0
  85. package/dist/common/playwrightContext.d.ts +31 -0
  86. package/dist/common/playwrightContext.js +154 -0
  87. package/dist/common/runApi/importUsingImportFunction.d.ts +7 -0
  88. package/dist/common/runApi/importUsingImportFunction.js +46 -0
  89. package/dist/common/runApi/index.d.ts +6 -9
  90. package/dist/common/runApi/index.js +75 -1782
  91. package/dist/common/settingsSchema.d.ts +9 -9
  92. package/dist/common/settingsSchema.js +20 -55
  93. package/dist/common/setupContextHook.d.ts +16 -0
  94. package/dist/common/setupContextHook.js +22 -0
  95. package/dist/common/telemetry.d.ts +3 -6
  96. package/dist/common/telemetry.js +8 -41
  97. package/dist/index.d.ts +4 -6
  98. package/dist/index.js +92 -784
  99. package/dist/runtime/RunError.d.ts +5 -0
  100. package/dist/runtime/RunError.js +19 -0
  101. package/dist/runtime/attemptStore.d.ts +2 -0
  102. package/dist/runtime/attemptStore.js +23 -0
  103. package/dist/runtime/captcha.d.ts +15 -0
  104. package/dist/runtime/captcha.js +191 -0
  105. package/dist/runtime/captcha.test.js +821 -0
  106. package/dist/runtime/downloadDirectory.d.ts +1 -0
  107. package/dist/runtime/downloadDirectory.js +19 -0
  108. package/dist/runtime/enums.d.js +5 -0
  109. package/dist/runtime/enums.d.ts +11 -0
  110. package/dist/runtime/enums.js +18 -0
  111. package/dist/runtime/executionHelpers.test.js +52 -0
  112. package/dist/runtime/export.d.js +5 -0
  113. package/dist/runtime/export.d.ts +284 -0
  114. package/dist/runtime/extendPayload.d.ts +2 -0
  115. package/dist/runtime/extendPayload.js +21 -0
  116. package/dist/runtime/extendTimeout.d.ts +1 -0
  117. package/dist/runtime/extendTimeout.js +23 -0
  118. package/dist/runtime/getAiGatewayConfig.d.ts +10 -0
  119. package/dist/runtime/getAiGatewayConfig.js +16 -0
  120. package/dist/runtime/getAuthSessionParameters.d.ts +1 -0
  121. package/dist/runtime/getAuthSessionParameters.js +20 -0
  122. package/dist/runtime/index.d.ts +10 -168
  123. package/dist/runtime/index.js +88 -779
  124. package/dist/runtime/persistentStore.d.ts +2 -0
  125. package/dist/runtime/persistentStore.js +37 -0
  126. package/dist/runtime/persistentStore.test.js +101 -0
  127. package/dist/runtime/runInfo.d.ts +2 -0
  128. package/dist/runtime/runInfo.js +21 -0
  129. package/dist/vendor/runtime-interface.d.ts +1 -0
  130. package/dist/vendor/runtime-interface.js +497 -0
  131. package/package.json +21 -75
  132. package/template.tsconfig.json +11 -0
  133. package/tsconfig.eslint.json +5 -0
  134. package/tsconfig.json +25 -0
  135. package/tsup.config.ts +12 -0
  136. package/typedoc.json +49 -0
  137. package/dist/chunk-3AGSY4RT.mjs +0 -1108
  138. package/dist/chunk-3AGSY4RT.mjs.map +0 -1
  139. package/dist/chunk-6ZRJOUQS.mjs +0 -16
  140. package/dist/chunk-6ZRJOUQS.mjs.map +0 -1
  141. package/dist/chunk-7YL2JUTE.mjs +0 -146
  142. package/dist/chunk-7YL2JUTE.mjs.map +0 -1
  143. package/dist/chunk-BF45RZ32.mjs +0 -13
  144. package/dist/chunk-BF45RZ32.mjs.map +0 -1
  145. package/dist/chunk-FGV5T6SI.mjs +0 -27
  146. package/dist/chunk-FGV5T6SI.mjs.map +0 -1
  147. package/dist/chunk-G4PO5RIV.mjs +0 -85
  148. package/dist/chunk-G4PO5RIV.mjs.map +0 -1
  149. package/dist/chunk-LZOMFHX3.mjs +0 -38
  150. package/dist/chunk-LZOMFHX3.mjs.map +0 -1
  151. package/dist/chunk-NDMVGENG.mjs.map +0 -1
  152. package/dist/chunk-UO2E7T7T.mjs +0 -787
  153. package/dist/chunk-UO2E7T7T.mjs.map +0 -1
  154. package/dist/chunk-W4UX6G4X.mjs +0 -17
  155. package/dist/chunk-W4UX6G4X.mjs.map +0 -1
  156. package/dist/chunk-XOAZ2MGA.mjs +0 -59
  157. package/dist/chunk-XOAZ2MGA.mjs.map +0 -1
  158. package/dist/commands/common/tsNodeImport.d.mts +0 -5
  159. package/dist/commands/common/tsNodeImport.js.map +0 -1
  160. package/dist/commands/common/tsNodeImport.mjs +0 -45
  161. package/dist/commands/common/tsNodeImport.mjs.map +0 -1
  162. package/dist/commands/interface/run.d.mts +0 -3
  163. package/dist/commands/interface/run.js.map +0 -1
  164. package/dist/commands/interface/run.mjs +0 -256
  165. package/dist/commands/interface/run.mjs.map +0 -1
  166. package/dist/common/asyncLocalStorage/index.d.mts +0 -17
  167. package/dist/common/asyncLocalStorage/index.js.map +0 -1
  168. package/dist/common/asyncLocalStorage/index.mjs +0 -12
  169. package/dist/common/asyncLocalStorage/index.mjs.map +0 -1
  170. package/dist/common/binStartupScript.d.mts +0 -2
  171. package/dist/common/binStartupScript.js.map +0 -1
  172. package/dist/common/binStartupScript.mjs +0 -135
  173. package/dist/common/binStartupScript.mjs.map +0 -1
  174. package/dist/common/cleanEnvironmentVariables.d.mts +0 -3
  175. package/dist/common/cleanEnvironmentVariables.js.map +0 -1
  176. package/dist/common/cleanEnvironmentVariables.mjs +0 -8
  177. package/dist/common/cleanEnvironmentVariables.mjs.map +0 -1
  178. package/dist/common/constants.d.mts +0 -13
  179. package/dist/common/constants.js.map +0 -1
  180. package/dist/common/constants.mjs +0 -28
  181. package/dist/common/constants.mjs.map +0 -1
  182. package/dist/common/contextStorageStateHelpers.d.mts +0 -24
  183. package/dist/common/contextStorageStateHelpers.js.map +0 -1
  184. package/dist/common/contextStorageStateHelpers.mjs +0 -10
  185. package/dist/common/contextStorageStateHelpers.mjs.map +0 -1
  186. package/dist/common/jwtTokenManager.d.mts +0 -19
  187. package/dist/common/jwtTokenManager.js.map +0 -1
  188. package/dist/common/jwtTokenManager.mjs +0 -11
  189. package/dist/common/jwtTokenManager.mjs.map +0 -1
  190. package/dist/common/runApi/index.d.mts +0 -11
  191. package/dist/common/runApi/index.js.map +0 -1
  192. package/dist/common/runApi/index.mjs +0 -19
  193. package/dist/common/runApi/index.mjs.map +0 -1
  194. package/dist/common/settingsSchema.d.mts +0 -540
  195. package/dist/common/settingsSchema.js.map +0 -1
  196. package/dist/common/settingsSchema.mjs +0 -10
  197. package/dist/common/settingsSchema.mjs.map +0 -1
  198. package/dist/common/telemetry.d.mts +0 -6
  199. package/dist/common/telemetry.js.map +0 -1
  200. package/dist/common/telemetry.mjs +0 -31
  201. package/dist/common/telemetry.mjs.map +0 -1
  202. package/dist/export.d-BAUMB-lG.d.mts +0 -140
  203. package/dist/export.d-BAUMB-lG.d.ts +0 -140
  204. package/dist/index.d.mts +0 -6
  205. package/dist/index.js.map +0 -1
  206. package/dist/index.mjs +0 -48
  207. package/dist/index.mjs.map +0 -1
  208. package/dist/runtime/index.d.mts +0 -168
  209. package/dist/runtime/index.js.map +0 -1
  210. package/dist/runtime/index.mjs +0 -43
  211. package/dist/runtime/index.mjs.map +0 -1
  212. /package/dist/common/assets/{assets/browser_scripts.js → browser_scripts.js} +0 -0
package/package.json CHANGED
@@ -1,82 +1,27 @@
1
1
  {
2
2
  "name": "@intuned/runtime-dev",
3
- "version": "1.3.18-interface.9",
3
+ "version": "1.3.21-dev.0",
4
4
  "description": "Intuned runtime",
5
5
  "packageManager": "yarn@4.12.0",
6
- "main": "./dist/index.cjs",
7
- "module": "./dist/index.js",
6
+ "main": "./dist/index.js",
8
7
  "types": "./dist/index.d.ts",
9
8
  "exports": {
10
- ".": {
11
- "types": "./dist/index.d.ts",
12
- "import": "./dist/index.js",
13
- "require": "./dist/index.cjs"
14
- },
15
- "./dist/runtime": {
16
- "types": "./dist/runtime/index.d.ts",
17
- "import": "./dist/runtime/index.js",
18
- "require": "./dist/runtime/index.cjs"
19
- },
20
- "./dist/common/runApi": {
21
- "types": "./dist/common/runApi/index.d.ts",
22
- "import": "./dist/common/runApi/index.js",
23
- "require": "./dist/common/runApi/index.cjs"
24
- },
25
- "./dist/common/settingsSchema": {
26
- "types": "./dist/common/settingsSchema.d.ts",
27
- "import": "./dist/common/settingsSchema.js",
28
- "require": "./dist/common/settingsSchema.cjs"
29
- },
30
- "./dist/common/contextStorageStateHelpers": {
31
- "types": "./dist/common/contextStorageStateHelpers.d.ts",
32
- "import": "./dist/common/contextStorageStateHelpers.js",
33
- "require": "./dist/common/contextStorageStateHelpers.cjs"
34
- },
35
- "./dist/common/telemetry": {
36
- "types": "./dist/common/telemetry.d.ts",
37
- "import": "./dist/common/telemetry.js",
38
- "require": "./dist/common/telemetry.cjs"
39
- },
40
- "./dist/common/jwtTokenManager": {
41
- "types": "./dist/common/jwtTokenManager.d.ts",
42
- "import": "./dist/common/jwtTokenManager.js",
43
- "require": "./dist/common/jwtTokenManager.cjs"
44
- },
45
- "./dist/common/asyncLocalStorage": {
46
- "types": "./dist/common/asyncLocalStorage/index.d.ts",
47
- "import": "./dist/common/asyncLocalStorage/index.js",
48
- "require": "./dist/common/asyncLocalStorage/index.cjs"
49
- },
50
- "./dist/common/cleanEnvironmentVariables": {
51
- "types": "./dist/common/cleanEnvironmentVariables.d.ts",
52
- "import": "./dist/common/cleanEnvironmentVariables.js",
53
- "require": "./dist/common/cleanEnvironmentVariables.cjs"
54
- },
55
- "./dist/common/constants": {
56
- "types": "./dist/common/constants.d.ts",
57
- "import": "./dist/common/constants.js",
58
- "require": "./dist/common/constants.cjs"
59
- },
60
- "./dist/commands/interface/run": {
61
- "types": "./dist/commands/interface/run.d.ts",
62
- "import": "./dist/commands/interface/run.js",
63
- "require": "./dist/commands/interface/run.cjs"
64
- },
65
- "./dist/common/binStartupScript": {
66
- "types": "./dist/common/binStartupScript.d.ts",
67
- "import": "./dist/common/binStartupScript.js",
68
- "require": "./dist/common/binStartupScript.cjs"
69
- },
70
- "./dist/commands/common/tsNodeImport": {
71
- "types": "./dist/commands/common/tsNodeImport.d.ts",
72
- "import": "./dist/commands/common/tsNodeImport.js",
73
- "require": "./dist/commands/common/tsNodeImport.cjs"
74
- }
9
+ ".": "./dist/index.js",
10
+ "./dist/runtime": "./dist/runtime/index.js",
11
+ "./dist/common/runApi": "./dist/common/runApi/index.js",
12
+ "./dist/common/settingsSchema": "./dist/common/settingsSchema.js",
13
+ "./dist/common/contextStorageStateHelpers": "./dist/common/contextStorageStateHelpers.js",
14
+ "./dist/common/telemetry": "./dist/common/telemetry.js",
15
+ "./dist/common/jwtTokenManager": "./dist/common/jwtTokenManager.js",
16
+ "./dist/common/asyncLocalStorage": "./dist/common/asyncLocalStorage/index.js",
17
+ "./dist/common/cleanEnvironmentVariables": "./dist/common/cleanEnvironmentVariables.js",
18
+ "./dist/common/constants": "./dist/common/constants.js",
19
+ "./dist/commands/interface/run": "./dist/commands/interface/run.js",
20
+ "./interface": "./dist/commands/interface/index.js",
21
+ "./dist/commands/intuned-run/intuned-run": "./dist/commands/intuned-run/intuned-run.js",
22
+ "./dist/common/binStartupScript": "./dist/common/binStartupScript.js",
23
+ "./dist/commands/common/utils/interfaceClient": "./dist/commands/common/utils/interfaceClient.js"
75
24
  },
76
- "files": [
77
- "dist",
78
- "bin"
79
- ],
80
25
  "author": "Intuned Team",
81
26
  "license": "Elastic-2.0",
82
27
  "scripts": {
@@ -88,9 +33,8 @@
88
33
  "intuned-auth-session-create": "vite-node ./src/commands/auth/run-create.ts",
89
34
  "intuned-auth-session-load": "vite-node ./src/commands/auth/load.ts",
90
35
  "intuned-ts-check": "yarn prepublishOnly && vite-node ./src/commands/ts-check.ts",
91
- "intuned": "vite-node ./src/commands/intuned-cli/main.ts",
92
36
  "intuned-get-headless-user-agent": "vite-node ./src/commands/get-headless-user-agent.ts",
93
- "build": "tsup && cp -r ./src/common/assets dist/common/assets",
37
+ "build": "rm -rf dist && tsc -p tsconfig.json && yarn copy-dts && babel src --out-dir dist --extensions '.ts' && tsup && cp -r ./src/common/assets dist/common/assets",
94
38
  "test": "vitest run",
95
39
  "test:watch": "vitest",
96
40
  "e2e": "yarn playwright test --config ./playwright.config.ts",
@@ -145,7 +89,7 @@
145
89
  "prettier": "2.8.0",
146
90
  "promptly": "3.2.0",
147
91
  "prompts": "^2.4.2",
148
- "rollup": "3.26.2",
92
+ "rollup": "3.30.0",
149
93
  "smol-toml": "^1.4.2",
150
94
  "source-map": "0.7.4",
151
95
  "terminal-kit": "^3.1.2",
@@ -156,6 +100,7 @@
156
100
  "typescript": "5.1.6",
157
101
  "uuid": "11.1.0",
158
102
  "wait-on": "7.2.0",
103
+ "which": "^6.0.1",
159
104
  "yaml": "2.8.1",
160
105
  "zod": "^3.21.4"
161
106
  },
@@ -179,6 +124,7 @@
179
124
  "@typescript-eslint/parser": "^7.5.0",
180
125
  "@vitest/ui": "^1.1.3",
181
126
  "babel-plugin-macros": "^3.1.0",
127
+ "babel-plugin-module-resolver": "^5.0.2",
182
128
  "babel-preset-minify": "^0.5.2",
183
129
  "copyfiles": "^2.4.1",
184
130
  "dts-bundle-generator": "^8.0.1",
@@ -0,0 +1,11 @@
1
+ {
2
+ "compilerOptions": {
3
+ "target": "ES2021",
4
+ "lib": ["dom", "es2021"],
5
+ "resolveJsonModule": true,
6
+ "esModuleInterop": true,
7
+ "moduleResolution": "bundler",
8
+ "module": "esnext",
9
+ "skipLibCheck": true
10
+ }
11
+ }
@@ -0,0 +1,5 @@
1
+ {
2
+ "extends": "./tsconfig.json",
3
+ "include": ["**/*.ts", "**/*.d.ts"],
4
+ "exclude": ["node_modules"]
5
+ }
package/tsconfig.json ADDED
@@ -0,0 +1,25 @@
1
+ {
2
+ "compilerOptions": {
3
+ "target": "es2021",
4
+ "module": "esnext",
5
+ "esModuleInterop": true,
6
+ "moduleResolution": "bundler",
7
+ "resolveJsonModule": true,
8
+ "outDir": "./dist",
9
+ "strict": false,
10
+ "strictNullChecks": true,
11
+ "rootDir": "./src",
12
+ "sourceMap": false,
13
+ "declaration": true,
14
+ "emitDeclarationOnly": false,
15
+ "skipLibCheck": true,
16
+ "types": ["vitest/globals"]
17
+ },
18
+ "include": [
19
+ "src/**/*.ts",
20
+ "src/**/*.d.ts",
21
+ "types-package/noEmpty.ts",
22
+ "src/assets/**/*"
23
+ ],
24
+ "exclude": ["node_modules", "**/*.test.ts", "**/__tests__/*"]
25
+ }
package/tsup.config.ts ADDED
@@ -0,0 +1,12 @@
1
+ import { defineConfig } from "tsup";
2
+
3
+ // bundle workspace dependencies
4
+ export default defineConfig({
5
+ entry: ["src/vendor/runtime-interface.ts"],
6
+ format: ["cjs"],
7
+ dts: true,
8
+ outDir: "dist/vendor",
9
+ clean: false, // Don't clean - babel handles dist cleanup
10
+ sourcemap: false,
11
+ target: "node20",
12
+ });
package/typedoc.json ADDED
@@ -0,0 +1,49 @@
1
+ {
2
+ // base config
3
+ "out": "docs/content",
4
+ "tsconfig": "./types-package/tsconfig.json",
5
+ "entryPoints": ["./types-package/ai-extractors/index.d.ts"],
6
+
7
+ // specific inclusions and exclusions
8
+ // "excludeProtected": true,
9
+ // "excludeNotDocumented": true,
10
+
11
+ "exclude": [
12
+ "./src.ts/_admin/**/*",
13
+ "./src.ts/_tests/**/*",
14
+ "./src.ts/testcases/**/*"
15
+ ],
16
+
17
+ // plugins
18
+ "plugin": [
19
+ // "./plugins/reorderSections.mjs",
20
+ "typedoc-plugin-remove-references", // remove additional references that clutter documentation
21
+ "typedoc-plugin-markdown", // generate markdown files
22
+ "typedoc-plugin-frontmatter", // add frontmatter to markdown files, prereq for the below custom plugin
23
+ "./docs/plugins/typedoc-plugin-mintlify-frontmatter.mjs", // formats frontmatter to match mintlify
24
+ "./docs/plugins/typedoc-plugin-navigation-output.mjs" // formats navigation to match mintlify
25
+ ],
26
+
27
+ // formatting + mintlify compatibility
28
+ "fileExtension": ".mdx", // use mdx files for mintlfiy compatibility
29
+ "entryFileName": "index.mdx", // rename entry from "README.md" to "index.mdx"
30
+ "hidePageHeader": true, // hide page header, conflicts with mintlify
31
+ "hidePageTitle": true, // hide page title, conflicts with mintlify
32
+ "hideBreadcrumbs": true, // hide breadcrumbs, conflicts with mintlify
33
+ "useCodeBlocks": true, // makes API definitions more readable
34
+
35
+ "expandObjects": false,
36
+ // "parametersFormat": "table", // readability
37
+ // "propertiesFormat": "table", // readability
38
+ "navigation": {
39
+ "includeCategories": true,
40
+ "includeGroups": false
41
+ },
42
+ "disableSources": true,
43
+ "hideParameterTypesInTitle": false,
44
+ // "membersWithOwnFile": ["Class", "Enum", "Interface", "Function"],
45
+ // "hideParameterTypesInTitle": true,
46
+ "readme": "none",
47
+ "githubPages": false,
48
+ "excludeExternals": true
49
+ }