@planqk/planqk-service-sdk 2.1.1 → 2.2.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 (173) hide show
  1. package/.gitlab-ci.yml +8 -39
  2. package/README-node.md +16 -12
  3. package/README.md +30 -41
  4. package/dist/sdk/Client.d.ts +10 -4
  5. package/dist/sdk/Client.js +46 -4
  6. package/dist/sdk/api/index.d.ts +2 -3
  7. package/dist/sdk/api/index.js +2 -3
  8. package/dist/sdk/api/resources/index.d.ts +2 -2
  9. package/dist/sdk/api/resources/index.js +2 -2
  10. package/dist/sdk/api/resources/serviceApi/client/Client.d.ts +41 -55
  11. package/dist/sdk/api/resources/serviceApi/client/Client.js +131 -227
  12. package/dist/sdk/api/resources/serviceApi/index.d.ts +2 -2
  13. package/dist/sdk/api/resources/serviceApi/index.js +2 -2
  14. package/dist/sdk/api/resources/serviceApi/types/GetResultResponse.d.ts +13 -3
  15. package/dist/sdk/api/resources/serviceApi/types/index.d.ts +1 -4
  16. package/dist/sdk/api/resources/serviceApi/types/index.js +1 -4
  17. package/dist/sdk/api/types/ServiceExecution.d.ts +12 -2
  18. package/dist/sdk/api/types/ServiceExecution.js +12 -0
  19. package/dist/sdk/api/types/index.d.ts +2 -6
  20. package/dist/sdk/api/types/index.js +2 -6
  21. package/dist/sdk/core/auth/BasicAuth.js +3 -3
  22. package/dist/sdk/core/auth/index.d.ts +2 -2
  23. package/dist/sdk/core/auth/index.js +4 -4
  24. package/dist/sdk/core/base64.d.ts +2 -0
  25. package/dist/sdk/core/base64.js +26 -0
  26. package/dist/sdk/core/fetcher/APIResponse.d.ts +10 -0
  27. package/dist/sdk/core/fetcher/BinaryResponse.d.ts +20 -0
  28. package/dist/sdk/core/fetcher/BinaryResponse.js +17 -0
  29. package/dist/sdk/core/fetcher/Fetcher.d.ts +5 -4
  30. package/dist/sdk/core/fetcher/Fetcher.js +41 -22
  31. package/dist/sdk/core/fetcher/Headers.d.ts +2 -0
  32. package/dist/sdk/core/fetcher/Headers.js +85 -0
  33. package/dist/sdk/core/fetcher/HttpResponsePromise.d.ts +58 -0
  34. package/dist/sdk/core/fetcher/HttpResponsePromise.js +94 -0
  35. package/dist/sdk/core/fetcher/RawResponse.d.ts +29 -0
  36. package/dist/sdk/core/fetcher/RawResponse.js +44 -0
  37. package/dist/sdk/core/fetcher/ResponseWithBody.d.ts +4 -0
  38. package/dist/sdk/core/fetcher/ResponseWithBody.js +6 -0
  39. package/dist/sdk/core/fetcher/createRequestUrl.d.ts +1 -1
  40. package/dist/sdk/core/fetcher/createRequestUrl.js +3 -7
  41. package/dist/sdk/core/fetcher/getErrorResponseBody.d.ts +1 -0
  42. package/dist/sdk/core/fetcher/getErrorResponseBody.js +32 -0
  43. package/dist/sdk/core/fetcher/getFetchFn.d.ts +1 -4
  44. package/dist/sdk/core/fetcher/getFetchFn.js +1 -52
  45. package/dist/sdk/core/fetcher/getRequestBody.js +2 -1
  46. package/dist/sdk/core/fetcher/getResponseBody.js +34 -30
  47. package/dist/sdk/core/fetcher/index.d.ts +9 -5
  48. package/dist/sdk/core/fetcher/index.js +13 -7
  49. package/dist/sdk/core/fetcher/makeRequest.js +3 -3
  50. package/dist/sdk/core/fetcher/requestWithRetries.js +14 -5
  51. package/dist/sdk/core/headers.d.ts +3 -0
  52. package/dist/sdk/core/headers.js +29 -0
  53. package/dist/sdk/core/index.d.ts +5 -3
  54. package/dist/sdk/core/index.js +28 -3
  55. package/dist/sdk/core/json.d.ts +15 -0
  56. package/dist/sdk/core/json.js +24 -0
  57. package/dist/sdk/core/runtime/index.d.ts +1 -1
  58. package/dist/sdk/core/runtime/index.js +2 -2
  59. package/dist/sdk/core/runtime/runtime.d.ts +1 -1
  60. package/dist/sdk/core/runtime/runtime.js +49 -40
  61. package/dist/sdk/core/url/index.d.ts +2 -0
  62. package/dist/sdk/core/url/index.js +7 -0
  63. package/dist/sdk/core/url/join.d.ts +1 -0
  64. package/dist/sdk/core/url/join.js +49 -0
  65. package/dist/sdk/core/url/qs.d.ts +6 -0
  66. package/dist/sdk/core/url/qs.js +67 -0
  67. package/dist/sdk/errors/PlanqkServiceApiError.d.ts +4 -1
  68. package/dist/sdk/errors/PlanqkServiceApiError.js +7 -8
  69. package/dist/sdk/errors/PlanqkServiceApiTimeoutError.d.ts +1 -1
  70. package/dist/sdk/errors/PlanqkServiceApiTimeoutError.js +2 -2
  71. package/dist/sdk/errors/index.d.ts +2 -2
  72. package/dist/sdk/errors/index.js +4 -4
  73. package/dist/sdk/index.d.ts +4 -4
  74. package/dist/sdk/index.js +9 -9
  75. package/fern/fern.config.json +1 -1
  76. package/fern/generators.yml +2 -2
  77. package/fern/openapi/openapi.yml +41 -131
  78. package/notebooks/python-sdk.ipynb +1 -1
  79. package/package.json +2 -3
  80. package/planqk/service/_version.py +1 -1
  81. package/pyproject.toml +1 -1
  82. package/src/index.test.ts +29 -16
  83. package/src/sdk/Client.ts +27 -7
  84. package/src/sdk/api/index.ts +2 -3
  85. package/src/sdk/api/resources/index.ts +2 -2
  86. package/src/sdk/api/resources/serviceApi/client/Client.ts +223 -250
  87. package/src/sdk/api/resources/serviceApi/index.ts +2 -2
  88. package/src/sdk/api/resources/serviceApi/types/GetResultResponse.ts +15 -3
  89. package/src/sdk/api/resources/serviceApi/types/index.ts +1 -4
  90. package/src/sdk/api/types/ServiceExecution.ts +13 -3
  91. package/src/sdk/api/types/index.ts +2 -6
  92. package/src/sdk/core/auth/BasicAuth.ts +3 -3
  93. package/src/sdk/core/auth/index.ts +2 -2
  94. package/src/sdk/core/base64.ts +27 -0
  95. package/src/sdk/core/fetcher/APIResponse.ts +11 -0
  96. package/src/sdk/core/fetcher/BinaryResponse.ts +36 -0
  97. package/src/sdk/core/fetcher/Fetcher.ts +46 -26
  98. package/src/sdk/core/fetcher/Headers.ts +93 -0
  99. package/src/sdk/core/fetcher/HttpResponsePromise.ts +116 -0
  100. package/src/sdk/core/fetcher/RawResponse.ts +61 -0
  101. package/src/sdk/core/fetcher/ResponseWithBody.ts +7 -0
  102. package/src/sdk/core/fetcher/createRequestUrl.ts +4 -8
  103. package/src/sdk/core/fetcher/getErrorResponseBody.ts +32 -0
  104. package/src/sdk/core/fetcher/getFetchFn.ts +2 -24
  105. package/src/sdk/core/fetcher/getRequestBody.ts +3 -1
  106. package/src/sdk/core/fetcher/getResponseBody.ts +38 -27
  107. package/src/sdk/core/fetcher/index.ts +9 -5
  108. package/src/sdk/core/fetcher/makeRequest.ts +2 -2
  109. package/src/sdk/core/fetcher/requestWithRetries.ts +18 -6
  110. package/src/sdk/core/fetcher/signals.ts +1 -1
  111. package/src/sdk/core/headers.ts +35 -0
  112. package/src/sdk/core/index.ts +5 -3
  113. package/src/sdk/core/json.ts +27 -0
  114. package/src/sdk/core/runtime/index.ts +1 -1
  115. package/src/sdk/core/runtime/runtime.ts +60 -53
  116. package/src/sdk/core/url/index.ts +2 -0
  117. package/src/sdk/core/url/join.ts +55 -0
  118. package/src/sdk/core/url/qs.ts +74 -0
  119. package/src/sdk/errors/PlanqkServiceApiError.ts +21 -11
  120. package/src/sdk/errors/PlanqkServiceApiTimeoutError.ts +2 -2
  121. package/src/sdk/errors/index.ts +2 -2
  122. package/src/sdk/index.ts +4 -4
  123. package/dist/sdk/api/errors/BadRequestError.d.ts +0 -7
  124. package/dist/sdk/api/errors/BadRequestError.js +0 -51
  125. package/dist/sdk/api/errors/ForbiddenError.d.ts +0 -7
  126. package/dist/sdk/api/errors/ForbiddenError.js +0 -51
  127. package/dist/sdk/api/errors/InternalServerError.d.ts +0 -7
  128. package/dist/sdk/api/errors/InternalServerError.js +0 -51
  129. package/dist/sdk/api/errors/NotFoundError.d.ts +0 -7
  130. package/dist/sdk/api/errors/NotFoundError.js +0 -51
  131. package/dist/sdk/api/errors/UnauthorizedError.d.ts +0 -7
  132. package/dist/sdk/api/errors/UnauthorizedError.js +0 -51
  133. package/dist/sdk/api/errors/index.d.ts +0 -5
  134. package/dist/sdk/api/errors/index.js +0 -21
  135. package/dist/sdk/api/resources/serviceApi/types/GetResultResponseEmbedded.d.ts +0 -7
  136. package/dist/sdk/api/resources/serviceApi/types/GetResultResponseEmbedded.js +0 -5
  137. package/dist/sdk/api/resources/serviceApi/types/GetResultResponseLinks.d.ts +0 -7
  138. package/dist/sdk/api/resources/serviceApi/types/GetResultResponseLinks.js +0 -5
  139. package/dist/sdk/api/resources/serviceApi/types/HealthCheckResponse.d.ts +0 -7
  140. package/dist/sdk/api/resources/serviceApi/types/HealthCheckResponse.js +0 -5
  141. package/dist/sdk/api/types/InputData.d.ts +0 -4
  142. package/dist/sdk/api/types/InputData.js +0 -5
  143. package/dist/sdk/api/types/InputDataRef.d.ts +0 -8
  144. package/dist/sdk/api/types/InputDataRef.js +0 -5
  145. package/dist/sdk/api/types/InputParams.d.ts +0 -4
  146. package/dist/sdk/api/types/InputParams.js +0 -5
  147. package/dist/sdk/api/types/ServiceExecutionStatus.d.ts +0 -12
  148. package/dist/sdk/api/types/ServiceExecutionStatus.js +0 -14
  149. package/dist/sdk/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +0 -30
  150. package/dist/sdk/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +0 -232
  151. package/dist/sdk/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +0 -21
  152. package/dist/sdk/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +0 -91
  153. package/dist/sdk/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +0 -31
  154. package/dist/sdk/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +0 -214
  155. package/dist/sdk/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +0 -18
  156. package/dist/sdk/core/fetcher/stream-wrappers/chooseStreamWrapper.js +0 -48
  157. package/src/sdk/api/errors/BadRequestError.ts +0 -16
  158. package/src/sdk/api/errors/ForbiddenError.ts +0 -16
  159. package/src/sdk/api/errors/InternalServerError.ts +0 -16
  160. package/src/sdk/api/errors/NotFoundError.ts +0 -16
  161. package/src/sdk/api/errors/UnauthorizedError.ts +0 -16
  162. package/src/sdk/api/errors/index.ts +0 -5
  163. package/src/sdk/api/resources/serviceApi/types/GetResultResponseEmbedded.ts +0 -9
  164. package/src/sdk/api/resources/serviceApi/types/GetResultResponseLinks.ts +0 -9
  165. package/src/sdk/api/resources/serviceApi/types/HealthCheckResponse.ts +0 -8
  166. package/src/sdk/api/types/InputData.ts +0 -5
  167. package/src/sdk/api/types/InputDataRef.ts +0 -9
  168. package/src/sdk/api/types/InputParams.ts +0 -5
  169. package/src/sdk/api/types/ServiceExecutionStatus.ts +0 -14
  170. package/src/sdk/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.ts +0 -252
  171. package/src/sdk/core/fetcher/stream-wrappers/NodePre18StreamWrapper.ts +0 -106
  172. package/src/sdk/core/fetcher/stream-wrappers/UndiciStreamWrapper.ts +0 -239
  173. package/src/sdk/core/fetcher/stream-wrappers/chooseStreamWrapper.ts +0 -33
@@ -1,239 +0,0 @@
1
- import { StreamWrapper } from "./chooseStreamWrapper";
2
-
3
- type EventCallback = (data?: any) => void;
4
-
5
- export class UndiciStreamWrapper<ReadFormat extends Uint8Array | Uint16Array | Uint32Array>
6
- implements StreamWrapper<UndiciStreamWrapper<ReadFormat> | WritableStream<ReadFormat>, ReadFormat>
7
- {
8
- private readableStream: ReadableStream<ReadFormat>;
9
- private reader: ReadableStreamDefaultReader<ReadFormat>;
10
- private events: Record<string, EventCallback[] | undefined>;
11
- private paused: boolean;
12
- private resumeCallback: ((value?: unknown) => void) | null;
13
- private encoding: string | null;
14
-
15
- constructor(readableStream: ReadableStream<ReadFormat>) {
16
- this.readableStream = readableStream;
17
- this.reader = this.readableStream.getReader();
18
- this.events = {
19
- data: [],
20
- end: [],
21
- error: [],
22
- readable: [],
23
- close: [],
24
- pause: [],
25
- resume: [],
26
- };
27
- this.paused = false;
28
- this.resumeCallback = null;
29
- this.encoding = null;
30
- }
31
-
32
- public on(event: string, callback: EventCallback): void {
33
- this.events[event]?.push(callback);
34
- }
35
-
36
- public off(event: string, callback: EventCallback): void {
37
- this.events[event] = this.events[event]?.filter((cb) => cb !== callback);
38
- }
39
-
40
- public pipe(
41
- dest: UndiciStreamWrapper<ReadFormat> | WritableStream<ReadFormat>
42
- ): UndiciStreamWrapper<ReadFormat> | WritableStream<ReadFormat> {
43
- this.on("data", (chunk) => {
44
- if (dest instanceof UndiciStreamWrapper) {
45
- dest._write(chunk);
46
- } else {
47
- const writer = dest.getWriter();
48
- writer.write(chunk).then(() => writer.releaseLock());
49
- }
50
- });
51
-
52
- this.on("end", () => {
53
- if (dest instanceof UndiciStreamWrapper) {
54
- dest._end();
55
- } else {
56
- const writer = dest.getWriter();
57
- writer.close();
58
- }
59
- });
60
-
61
- this.on("error", (error) => {
62
- if (dest instanceof UndiciStreamWrapper) {
63
- dest._error(error);
64
- } else {
65
- const writer = dest.getWriter();
66
- writer.abort(error);
67
- }
68
- });
69
-
70
- this._startReading();
71
-
72
- return dest;
73
- }
74
-
75
- public pipeTo(
76
- dest: UndiciStreamWrapper<ReadFormat> | WritableStream<ReadFormat>
77
- ): UndiciStreamWrapper<ReadFormat> | WritableStream<ReadFormat> {
78
- return this.pipe(dest);
79
- }
80
-
81
- public unpipe(dest: UndiciStreamWrapper<ReadFormat> | WritableStream<any>): void {
82
- this.off("data", (chunk) => {
83
- if (dest instanceof UndiciStreamWrapper) {
84
- dest._write(chunk);
85
- } else {
86
- const writer = dest.getWriter();
87
- writer.write(chunk).then(() => writer.releaseLock());
88
- }
89
- });
90
-
91
- this.off("end", () => {
92
- if (dest instanceof UndiciStreamWrapper) {
93
- dest._end();
94
- } else {
95
- const writer = dest.getWriter();
96
- writer.close();
97
- }
98
- });
99
-
100
- this.off("error", (error) => {
101
- if (dest instanceof UndiciStreamWrapper) {
102
- dest._error(error);
103
- } else {
104
- const writer = dest.getWriter();
105
- writer.abort(error);
106
- }
107
- });
108
- }
109
-
110
- public destroy(error?: Error): void {
111
- this.reader
112
- .cancel(error)
113
- .then(() => {
114
- this._emit("close");
115
- })
116
- .catch((err) => {
117
- this._emit("error", err);
118
- });
119
- }
120
-
121
- public pause(): void {
122
- this.paused = true;
123
- this._emit("pause");
124
- }
125
-
126
- public resume(): void {
127
- if (this.paused) {
128
- this.paused = false;
129
- this._emit("resume");
130
- if (this.resumeCallback) {
131
- this.resumeCallback();
132
- this.resumeCallback = null;
133
- }
134
- }
135
- }
136
-
137
- public get isPaused(): boolean {
138
- return this.paused;
139
- }
140
-
141
- public async read(): Promise<ReadFormat | undefined> {
142
- if (this.paused) {
143
- await new Promise((resolve) => {
144
- this.resumeCallback = resolve;
145
- });
146
- }
147
- const { done, value } = await this.reader.read();
148
- if (done) {
149
- return undefined;
150
- }
151
- return value;
152
- }
153
-
154
- public setEncoding(encoding: string): void {
155
- this.encoding = encoding;
156
- }
157
-
158
- public async text(): Promise<string> {
159
- const chunks: BlobPart[] = [];
160
-
161
- while (true) {
162
- const { done, value } = await this.reader.read();
163
- if (done) break;
164
- if (value) chunks.push(value);
165
- }
166
-
167
- const decoder = new TextDecoder(this.encoding || "utf-8");
168
- return decoder.decode(await new Blob(chunks).arrayBuffer());
169
- }
170
-
171
- public async json<T>(): Promise<T> {
172
- const text = await this.text();
173
- return JSON.parse(text);
174
- }
175
-
176
- private _write(chunk: ReadFormat): void {
177
- this._emit("data", chunk);
178
- }
179
-
180
- private _end(): void {
181
- this._emit("end");
182
- }
183
-
184
- private _error(error: any): void {
185
- this._emit("error", error);
186
- }
187
-
188
- private _emit(event: string, data?: any): void {
189
- if (this.events[event]) {
190
- for (const callback of this.events[event] || []) {
191
- callback(data);
192
- }
193
- }
194
- }
195
-
196
- private async _startReading(): Promise<void> {
197
- try {
198
- this._emit("readable");
199
- while (true) {
200
- if (this.paused) {
201
- await new Promise((resolve) => {
202
- this.resumeCallback = resolve;
203
- });
204
- }
205
- const { done, value } = await this.reader.read();
206
- if (done) {
207
- this._emit("end");
208
- this._emit("close");
209
- break;
210
- }
211
- if (value) {
212
- this._emit("data", value);
213
- }
214
- }
215
- } catch (error) {
216
- this._emit("error", error);
217
- }
218
- }
219
-
220
- [Symbol.asyncIterator](): AsyncIterableIterator<ReadFormat> {
221
- return {
222
- next: async () => {
223
- if (this.paused) {
224
- await new Promise((resolve) => {
225
- this.resumeCallback = resolve;
226
- });
227
- }
228
- const { done, value } = await this.reader.read();
229
- if (done) {
230
- return { done: true, value: undefined };
231
- }
232
- return { done: false, value };
233
- },
234
- [Symbol.asyncIterator]() {
235
- return this;
236
- },
237
- };
238
- }
239
- }
@@ -1,33 +0,0 @@
1
- import type { Readable } from "stream";
2
- import { RUNTIME } from "../../runtime";
3
-
4
- export type EventCallback = (data?: any) => void;
5
-
6
- export interface StreamWrapper<WritableStream, ReadFormat> {
7
- setEncoding(encoding?: string): void;
8
- on(event: string, callback: EventCallback): void;
9
- off(event: string, callback: EventCallback): void;
10
- pipe(dest: WritableStream): WritableStream;
11
- pipeTo(dest: WritableStream): WritableStream;
12
- unpipe(dest?: WritableStream): void;
13
- destroy(error?: Error): void;
14
- pause(): void;
15
- resume(): void;
16
- get isPaused(): boolean;
17
- read(): Promise<ReadFormat | undefined>;
18
- text(): Promise<string>;
19
- json<T>(): Promise<T>;
20
- [Symbol.asyncIterator](): AsyncIterableIterator<ReadFormat>;
21
- }
22
-
23
- export async function chooseStreamWrapper(responseBody: any): Promise<Promise<StreamWrapper<any, any>>> {
24
- if (RUNTIME.type === "node" && RUNTIME.parsedVersion != null && RUNTIME.parsedVersion >= 18) {
25
- return new (await import("./Node18UniversalStreamWrapper")).Node18UniversalStreamWrapper(
26
- responseBody as ReadableStream
27
- );
28
- } else if (RUNTIME.type !== "node" && typeof fetch == "function") {
29
- return new (await import("./UndiciStreamWrapper")).UndiciStreamWrapper(responseBody as ReadableStream);
30
- } else {
31
- return new (await import("./NodePre18StreamWrapper")).NodePre18StreamWrapper(responseBody as Readable);
32
- }
33
- }