@northflank/js-client 0.4.1 → 0.5.2

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 (258) hide show
  1. package/README.md +4 -4
  2. package/dist/cjs/api-client.d.ts +5819 -0
  3. package/dist/cjs/api-client.js +1 -0
  4. package/dist/cjs/package.json +3 -0
  5. package/dist/esm/api-client.d.ts +5819 -0
  6. package/dist/esm/api-client.js +15 -0
  7. package/dist/esm/package.json +3 -0
  8. package/package.json +13 -20
  9. package/dist/api-client.d.ts +0 -481
  10. package/dist/api-client.js +0 -748
  11. package/dist/api-endpoint.d.ts +0 -63
  12. package/dist/api-endpoint.js +0 -216
  13. package/dist/context/api-client-context-provider.d.ts +0 -47
  14. package/dist/context/api-client-context-provider.js +0 -332
  15. package/dist/context/api-client-file-context-provider.d.ts +0 -11
  16. package/dist/context/api-client-file-context-provider.js +0 -138
  17. package/dist/context/api-client-in-memory-context-provider.d.ts +0 -6
  18. package/dist/context/api-client-in-memory-context-provider.js +0 -82
  19. package/dist/context/index.d.ts +0 -3
  20. package/dist/context/index.js +0 -15
  21. package/dist/endpoints/abort/addon/backup.d.ts +0 -21
  22. package/dist/endpoints/abort/addon/backup.js +0 -36
  23. package/dist/endpoints/abort/addon/restore.d.ts +0 -26
  24. package/dist/endpoints/abort/addon/restore.js +0 -36
  25. package/dist/endpoints/abort/job/build.d.ts +0 -21
  26. package/dist/endpoints/abort/job/build.js +0 -36
  27. package/dist/endpoints/abort/job/run.d.ts +0 -21
  28. package/dist/endpoints/abort/job/run.js +0 -36
  29. package/dist/endpoints/abort/service/build.d.ts +0 -21
  30. package/dist/endpoints/abort/service/build.js +0 -36
  31. package/dist/endpoints/add/domain/subdomain.d.ts +0 -33
  32. package/dist/endpoints/add/domain/subdomain.js +0 -36
  33. package/dist/endpoints/add/registryCredentials.d.ts +0 -47
  34. package/dist/endpoints/add/registryCredentials.js +0 -36
  35. package/dist/endpoints/assign/subdomain/service.d.ts +0 -28
  36. package/dist/endpoints/assign/subdomain/service.js +0 -36
  37. package/dist/endpoints/backup/addon.d.ts +0 -51
  38. package/dist/endpoints/backup/addon.js +0 -36
  39. package/dist/endpoints/create/addon.d.ts +0 -90
  40. package/dist/endpoints/create/addon.js +0 -36
  41. package/dist/endpoints/create/domain.d.ts +0 -27
  42. package/dist/endpoints/create/domain.js +0 -36
  43. package/dist/endpoints/create/job/cron.d.ts +0 -157
  44. package/dist/endpoints/create/job/cron.js +0 -36
  45. package/dist/endpoints/create/job/manual.d.ts +0 -147
  46. package/dist/endpoints/create/job/manual.js +0 -36
  47. package/dist/endpoints/create/project.d.ts +0 -29
  48. package/dist/endpoints/create/project.js +0 -36
  49. package/dist/endpoints/create/secret.d.ts +0 -79
  50. package/dist/endpoints/create/secret.js +0 -36
  51. package/dist/endpoints/create/service/build.d.ts +0 -116
  52. package/dist/endpoints/create/service/build.js +0 -36
  53. package/dist/endpoints/create/service/combined.d.ts +0 -166
  54. package/dist/endpoints/create/service/combined.js +0 -36
  55. package/dist/endpoints/create/service/deployment.d.ts +0 -137
  56. package/dist/endpoints/create/service/deployment.js +0 -36
  57. package/dist/endpoints/delete/addon.d.ts +0 -19
  58. package/dist/endpoints/delete/addon.js +0 -36
  59. package/dist/endpoints/delete/backup.d.ts +0 -21
  60. package/dist/endpoints/delete/backup.js +0 -36
  61. package/dist/endpoints/delete/domain.d.ts +0 -17
  62. package/dist/endpoints/delete/domain.js +0 -36
  63. package/dist/endpoints/delete/job.d.ts +0 -19
  64. package/dist/endpoints/delete/job.js +0 -36
  65. package/dist/endpoints/delete/project.d.ts +0 -17
  66. package/dist/endpoints/delete/project.js +0 -36
  67. package/dist/endpoints/delete/registryCredentials.d.ts +0 -17
  68. package/dist/endpoints/delete/registryCredentials.js +0 -36
  69. package/dist/endpoints/delete/secret.d.ts +0 -19
  70. package/dist/endpoints/delete/secret.js +0 -36
  71. package/dist/endpoints/delete/secretLink.d.ts +0 -21
  72. package/dist/endpoints/delete/secretLink.js +0 -36
  73. package/dist/endpoints/delete/service.d.ts +0 -19
  74. package/dist/endpoints/delete/service.js +0 -36
  75. package/dist/endpoints/delete/subdomain.d.ts +0 -19
  76. package/dist/endpoints/delete/subdomain.js +0 -36
  77. package/dist/endpoints/get/addon/backup/download.d.ts +0 -24
  78. package/dist/endpoints/get/addon/backup/download.js +0 -36
  79. package/dist/endpoints/get/addon/backup.d.ts +0 -46
  80. package/dist/endpoints/get/addon/backup.js +0 -36
  81. package/dist/endpoints/get/addon/backups.d.ts +0 -54
  82. package/dist/endpoints/get/addon/backups.js +0 -40
  83. package/dist/endpoints/get/addon/containers.d.ts +0 -40
  84. package/dist/endpoints/get/addon/containers.js +0 -40
  85. package/dist/endpoints/get/addon/credentials.d.ts +0 -24
  86. package/dist/endpoints/get/addon/credentials.js +0 -36
  87. package/dist/endpoints/get/addon/types.d.ts +0 -48
  88. package/dist/endpoints/get/addon/types.js +0 -36
  89. package/dist/endpoints/get/addon/version.d.ts +0 -53
  90. package/dist/endpoints/get/addon/version.js +0 -36
  91. package/dist/endpoints/get/addon.d.ts +0 -69
  92. package/dist/endpoints/get/addon.js +0 -36
  93. package/dist/endpoints/get/dnsId.d.ts +0 -15
  94. package/dist/endpoints/get/dnsId.js +0 -36
  95. package/dist/endpoints/get/domain.d.ts +0 -33
  96. package/dist/endpoints/get/domain.js +0 -36
  97. package/dist/endpoints/get/job/buildArguments.d.ts +0 -19
  98. package/dist/endpoints/get/job/buildArguments.js +0 -36
  99. package/dist/endpoints/get/job/builds.d.ts +0 -50
  100. package/dist/endpoints/get/job/builds.js +0 -39
  101. package/dist/endpoints/get/job/containers.d.ts +0 -40
  102. package/dist/endpoints/get/job/containers.js +0 -40
  103. package/dist/endpoints/get/job/deployment.d.ts +0 -51
  104. package/dist/endpoints/get/job/deployment.js +0 -36
  105. package/dist/endpoints/get/job/environment.d.ts +0 -24
  106. package/dist/endpoints/get/job/environment.js +0 -40
  107. package/dist/endpoints/get/job/environmentDetails.d.ts +0 -42
  108. package/dist/endpoints/get/job/environmentDetails.js +0 -36
  109. package/dist/endpoints/get/job/healthChecks.d.ts +0 -44
  110. package/dist/endpoints/get/job/healthChecks.js +0 -36
  111. package/dist/endpoints/get/job/run.d.ts +0 -42
  112. package/dist/endpoints/get/job/run.js +0 -36
  113. package/dist/endpoints/get/job/runs.d.ts +0 -52
  114. package/dist/endpoints/get/job/runs.js +0 -39
  115. package/dist/endpoints/get/job.d.ts +0 -86
  116. package/dist/endpoints/get/job.js +0 -36
  117. package/dist/endpoints/get/project.d.ts +0 -72
  118. package/dist/endpoints/get/project.js +0 -36
  119. package/dist/endpoints/get/registryCredentials.d.ts +0 -34
  120. package/dist/endpoints/get/registryCredentials.js +0 -36
  121. package/dist/endpoints/get/secret.d.ts +0 -55
  122. package/dist/endpoints/get/secret.js +0 -39
  123. package/dist/endpoints/get/secretDetails.d.ts +0 -63
  124. package/dist/endpoints/get/secretDetails.js +0 -36
  125. package/dist/endpoints/get/secretLink.d.ts +0 -44
  126. package/dist/endpoints/get/secretLink.js +0 -36
  127. package/dist/endpoints/get/service/buildArguments.d.ts +0 -19
  128. package/dist/endpoints/get/service/buildArguments.js +0 -36
  129. package/dist/endpoints/get/service/builds.d.ts +0 -50
  130. package/dist/endpoints/get/service/builds.js +0 -40
  131. package/dist/endpoints/get/service/containers.d.ts +0 -40
  132. package/dist/endpoints/get/service/containers.js +0 -40
  133. package/dist/endpoints/get/service/deployment.d.ts +0 -51
  134. package/dist/endpoints/get/service/deployment.js +0 -36
  135. package/dist/endpoints/get/service/environmentVariableDetails.d.ts +0 -42
  136. package/dist/endpoints/get/service/environmentVariableDetails.js +0 -36
  137. package/dist/endpoints/get/service/environmentVariables.d.ts +0 -24
  138. package/dist/endpoints/get/service/environmentVariables.js +0 -40
  139. package/dist/endpoints/get/service/healthChecks.d.ts +0 -44
  140. package/dist/endpoints/get/service/healthChecks.js +0 -36
  141. package/dist/endpoints/get/service/ports.d.ts +0 -35
  142. package/dist/endpoints/get/service/ports.js +0 -36
  143. package/dist/endpoints/get/service.d.ts +0 -103
  144. package/dist/endpoints/get/service.js +0 -36
  145. package/dist/endpoints/get/subdomain.d.ts +0 -30
  146. package/dist/endpoints/get/subdomain.js +0 -36
  147. package/dist/endpoints/import/addon/backup.d.ts +0 -31
  148. package/dist/endpoints/import/addon/backup.js +0 -36
  149. package/dist/endpoints/list/addons.d.ts +0 -45
  150. package/dist/endpoints/list/addons.js +0 -39
  151. package/dist/endpoints/list/domains.d.ts +0 -34
  152. package/dist/endpoints/list/domains.js +0 -39
  153. package/dist/endpoints/list/jobs.d.ts +0 -44
  154. package/dist/endpoints/list/jobs.js +0 -39
  155. package/dist/endpoints/list/plans.d.ts +0 -30
  156. package/dist/endpoints/list/plans.js +0 -36
  157. package/dist/endpoints/list/projects.d.ts +0 -32
  158. package/dist/endpoints/list/projects.js +0 -39
  159. package/dist/endpoints/list/regions.d.ts +0 -18
  160. package/dist/endpoints/list/regions.js +0 -36
  161. package/dist/endpoints/list/registryCredentials.d.ts +0 -41
  162. package/dist/endpoints/list/registryCredentials.js +0 -39
  163. package/dist/endpoints/list/secrets.d.ts +0 -52
  164. package/dist/endpoints/list/secrets.js +0 -39
  165. package/dist/endpoints/list/services.d.ts +0 -44
  166. package/dist/endpoints/list/services.js +0 -39
  167. package/dist/endpoints/list/vcs.d.ts +0 -51
  168. package/dist/endpoints/list/vcs.js +0 -36
  169. package/dist/endpoints/pause/addon.d.ts +0 -19
  170. package/dist/endpoints/pause/addon.js +0 -36
  171. package/dist/endpoints/pause/service.d.ts +0 -19
  172. package/dist/endpoints/pause/service.js +0 -36
  173. package/dist/endpoints/restart/addon.d.ts +0 -19
  174. package/dist/endpoints/restart/addon.js +0 -36
  175. package/dist/endpoints/restart/service.d.ts +0 -19
  176. package/dist/endpoints/restart/service.js +0 -36
  177. package/dist/endpoints/restore/addon/backup.d.ts +0 -21
  178. package/dist/endpoints/restore/addon/backup.js +0 -36
  179. package/dist/endpoints/resume/addon.d.ts +0 -19
  180. package/dist/endpoints/resume/addon.js +0 -36
  181. package/dist/endpoints/resume/service.d.ts +0 -24
  182. package/dist/endpoints/resume/service.js +0 -36
  183. package/dist/endpoints/scale/addon.d.ts +0 -28
  184. package/dist/endpoints/scale/addon.js +0 -36
  185. package/dist/endpoints/scale/service.d.ts +0 -26
  186. package/dist/endpoints/scale/service.js +0 -36
  187. package/dist/endpoints/start/job/build.d.ts +0 -37
  188. package/dist/endpoints/start/job/build.js +0 -36
  189. package/dist/endpoints/start/job/run.d.ts +0 -37
  190. package/dist/endpoints/start/job/run.js +0 -36
  191. package/dist/endpoints/start/service/build.d.ts +0 -41
  192. package/dist/endpoints/start/service/build.js +0 -36
  193. package/dist/endpoints/unassign/subdomain.d.ts +0 -19
  194. package/dist/endpoints/unassign/subdomain.js +0 -36
  195. package/dist/endpoints/update/addon/networkSettings.d.ts +0 -26
  196. package/dist/endpoints/update/addon/networkSettings.js +0 -36
  197. package/dist/endpoints/update/addon/security.d.ts +0 -29
  198. package/dist/endpoints/update/addon/security.js +0 -36
  199. package/dist/endpoints/update/addon/version.d.ts +0 -24
  200. package/dist/endpoints/update/addon/version.js +0 -36
  201. package/dist/endpoints/update/job/buildArguments.d.ts +0 -24
  202. package/dist/endpoints/update/job/buildArguments.js +0 -36
  203. package/dist/endpoints/update/job/cmdOverride.d.ts +0 -24
  204. package/dist/endpoints/update/job/cmdOverride.js +0 -36
  205. package/dist/endpoints/update/job/deployment.d.ts +0 -37
  206. package/dist/endpoints/update/job/deployment.js +0 -36
  207. package/dist/endpoints/update/job/environment.d.ts +0 -24
  208. package/dist/endpoints/update/job/environment.js +0 -36
  209. package/dist/endpoints/update/job/healthChecks.d.ts +0 -45
  210. package/dist/endpoints/update/job/healthChecks.js +0 -36
  211. package/dist/endpoints/update/job/settings.d.ts +0 -30
  212. package/dist/endpoints/update/job/settings.js +0 -36
  213. package/dist/endpoints/update/registryCredentials.d.ts +0 -31
  214. package/dist/endpoints/update/registryCredentials.js +0 -36
  215. package/dist/endpoints/update/secret.d.ts +0 -54
  216. package/dist/endpoints/update/secret.js +0 -36
  217. package/dist/endpoints/update/secretLink.d.ts +0 -40
  218. package/dist/endpoints/update/secretLink.js +0 -36
  219. package/dist/endpoints/update/service/buildArguments.d.ts +0 -24
  220. package/dist/endpoints/update/service/buildArguments.js +0 -36
  221. package/dist/endpoints/update/service/buildOptions.d.ts +0 -52
  222. package/dist/endpoints/update/service/buildOptions.js +0 -36
  223. package/dist/endpoints/update/service/cmdOverride.d.ts +0 -24
  224. package/dist/endpoints/update/service/cmdOverride.js +0 -36
  225. package/dist/endpoints/update/service/deployment.d.ts +0 -37
  226. package/dist/endpoints/update/service/deployment.js +0 -36
  227. package/dist/endpoints/update/service/environmentVariables.d.ts +0 -29
  228. package/dist/endpoints/update/service/environmentVariables.js +0 -36
  229. package/dist/endpoints/update/service/healthChecks.d.ts +0 -45
  230. package/dist/endpoints/update/service/healthChecks.js +0 -36
  231. package/dist/endpoints/update/service/ports.d.ts +0 -55
  232. package/dist/endpoints/update/service/ports.js +0 -36
  233. package/dist/endpoints/verify/domain.d.ts +0 -17
  234. package/dist/endpoints/verify/domain.js +0 -36
  235. package/dist/endpoints/verify/subdomain.d.ts +0 -19
  236. package/dist/endpoints/verify/subdomain.js +0 -36
  237. package/dist/port-forward/client/api-helper.d.ts +0 -30
  238. package/dist/port-forward/client/api-helper.js +0 -102
  239. package/dist/port-forward/client/atomic-write.d.ts +0 -3
  240. package/dist/port-forward/client/atomic-write.js +0 -95
  241. package/dist/port-forward/client/host-file-ast.d.ts +0 -52
  242. package/dist/port-forward/client/host-file-ast.js +0 -279
  243. package/dist/port-forward/client/host-file.d.ts +0 -26
  244. package/dist/port-forward/client/host-file.js +0 -226
  245. package/dist/port-forward/client/loopback.d.ts +0 -4
  246. package/dist/port-forward/client/loopback.js +0 -219
  247. package/dist/port-forward/client/port-forwarder.d.ts +0 -86
  248. package/dist/port-forward/client/port-forwarder.js +0 -593
  249. package/dist/port-forward/client/port-tunnel-tcp.d.ts +0 -34
  250. package/dist/port-forward/client/port-tunnel-tcp.js +0 -209
  251. package/dist/port-forward/client/port-tunnel-udp.d.ts +0 -25
  252. package/dist/port-forward/client/port-tunnel-udp.js +0 -147
  253. package/dist/port-forward/client/port-tunnel.d.ts +0 -32
  254. package/dist/port-forward/client/port-tunnel.js +0 -2
  255. package/dist/port-forward/client/promise-mutex.d.ts +0 -4
  256. package/dist/port-forward/client/promise-mutex.js +0 -62
  257. package/dist/utils.d.ts +0 -8
  258. package/dist/utils.js +0 -97
package/README.md CHANGED
@@ -1,5 +1,5 @@
1
- ## Northflank api-client package
2
- Node.js client for the Northflank platform based on the Northflank public api.
1
+ ## Northflank API js-client package
2
+ Node.js client for the Northflank platform based on the Northflank public API.
3
3
 
4
4
  *Visit our website [www.northflank.com](https://www.northflank.com)*
5
5
 
@@ -17,8 +17,8 @@ Add as a dependency to your project with
17
17
 
18
18
  ### Using the package
19
19
  Example usage:
20
- ```
21
- import { ApiClient, ApiClientInMemoryContextProvider} from '@northflank/js-client';
20
+ ```javascript
21
+ import { ApiClient, ApiClientInMemoryContextProvider } from '@northflank/js-client';
22
22
 
23
23
  (async () => {
24
24
  // Create context to store credentials.