@giveitsmaller/sdk 0.19.0 → 0.21.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 (45) hide show
  1. package/LICENSE +202 -0
  2. package/README.md +8 -15
  3. package/dist/_audit.js +14 -4
  4. package/dist/builder.d.ts +5 -4
  5. package/dist/builder.js +16 -16
  6. package/dist/client.d.ts +17 -7
  7. package/dist/client.js +116 -62
  8. package/dist/ergonomic/image_output_routes.d.ts +30 -0
  9. package/dist/ergonomic/image_output_routes.js +82 -11
  10. package/dist/ergonomic/option_types.d.ts +34 -1
  11. package/dist/ergonomic/option_types.js +5 -1
  12. package/dist/ergonomic/option_validation.d.ts +19 -1
  13. package/dist/ergonomic/option_validation.js +34 -1
  14. package/dist/ergonomic/preset_resolver.d.ts +2 -2
  15. package/dist/ergonomic/preset_resolver.js +6 -10
  16. package/dist/ergonomic/presets/index.d.ts +9 -8
  17. package/dist/ergonomic/presets/index.js +1 -9
  18. package/dist/errors.d.ts +105 -3
  19. package/dist/errors.js +136 -2
  20. package/dist/file-first.d.ts +234 -16
  21. package/dist/file-first.js +692 -175
  22. package/dist/generated/sdk_spec/enums.d.ts +0 -26
  23. package/dist/generated/sdk_spec/enums.js +0 -16
  24. package/dist/generated/sdk_spec/errors.d.ts +1 -1
  25. package/dist/generated/sdk_spec/errors.js +12 -0
  26. package/dist/generated/sdk_spec/presets.js +0 -14
  27. package/dist/generated/sdk_spec/version.d.ts +2 -2
  28. package/dist/generated/sdk_spec/version.js +2 -2
  29. package/dist/gisl.d.ts +93 -5
  30. package/dist/gisl.js +72 -2
  31. package/dist/handle.d.ts +6 -1
  32. package/dist/handle.js +42 -13
  33. package/dist/index.core.d.ts +10 -8
  34. package/dist/index.core.js +11 -3
  35. package/dist/merge.d.ts +12 -0
  36. package/dist/merge.js +14 -2
  37. package/dist/retry-metadata.d.ts +37 -0
  38. package/dist/retry-metadata.js +86 -0
  39. package/dist/sse.d.ts +2 -1
  40. package/dist/sse.js +26 -6
  41. package/dist/types.d.ts +54 -4
  42. package/dist/types.js +1 -0
  43. package/package.json +3 -3
  44. package/dist/ergonomic/presets/document_pdf_compress.d.ts +0 -12
  45. package/dist/ergonomic/presets/document_pdf_compress.js +0 -33
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/README.md CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  TypeScript / Node.js SDK for the [GISL](https://giveitsmaller.com) (Give It Smaller) file compression and processing API.
4
4
 
5
+ > **Read-only mirror.** This repository is automatically published from Give It Smaller's private monorepo on each release. Do **not** open issues or pull requests here — they are not monitored. Licensed under [Apache-2.0](./LICENSE).
6
+
5
7
  ## Install
6
8
 
7
9
  ```bash
@@ -44,9 +46,7 @@ for (const artifact of many.artifacts) console.log(artifact.url);
44
46
  > `client.compress(path, { ... }).run()` form (and `thumbnail` / `convert`) is
45
47
  > available, and the raw wire client — `client.createWorkflow({ jobs: [...] })`
46
48
  > with `uploadSource` / `OperationType` for hand-built job DAGs — is the advanced
47
- > escape hatch. File-first is the recommended direction the
48
- > [examples](https://github.com/AntonioCS/giveitsmaller-sdks/tree/main/docs/typescript/examples)
49
- > build on.
49
+ > escape hatch. File-first is the recommended direction to build on.
50
50
 
51
51
  > **Reusing an upload id across clients?** An upload created by an
52
52
  > authenticated caller is owned by that caller. If you persist a `fileId` and
@@ -56,18 +56,11 @@ for (const artifact of many.artifacts) console.log(artifact.url);
56
56
  > only under the same auth that created it; the upload-then-create flow above is
57
57
  > consistent by construction. Anonymous-intake uploads are unaffected.
58
58
 
59
- ## Full documentation
60
-
61
- Docs are published in the [giveitsmaller-sdks](https://github.com/AntonioCS/giveitsmaller-sdks) repository — they are **not** shipped in the npm tarball (only `dist/` is published).
59
+ ## Documentation
62
60
 
63
- - **Getting started & concepts** [`docs/typescript/index.md`](https://github.com/AntonioCS/giveitsmaller-sdks/blob/main/docs/typescript/index.md)
64
- - **Client reference** (all `GislClient` methods + operation option list) — [`docs/typescript/client.md`](https://github.com/AntonioCS/giveitsmaller-sdks/blob/main/docs/typescript/client.md)
65
- - **Types & authoring primitives** (config, payloads, job factories) — [`docs/typescript/types.md`](https://github.com/AntonioCS/giveitsmaller-sdks/blob/main/docs/typescript/types.md)
66
- - **SSE / live progress** — [`docs/typescript/sse.md`](https://github.com/AntonioCS/giveitsmaller-sdks/blob/main/docs/typescript/sse.md)
67
- - **Webhooks** — [`docs/typescript/webhook.md`](https://github.com/AntonioCS/giveitsmaller-sdks/blob/main/docs/typescript/webhook.md)
68
- - **Errors & retry guidance** — [`docs/typescript/errors.md`](https://github.com/AntonioCS/giveitsmaller-sdks/blob/main/docs/typescript/errors.md)
69
- - **Troubleshooting** — [`docs/typescript/troubleshooting.md`](https://github.com/AntonioCS/giveitsmaller-sdks/blob/main/docs/typescript/troubleshooting.md)
70
- - **Examples** — compress, thumbnail, convert, merge, archive, watermark, output — [`docs/typescript/examples/`](https://github.com/AntonioCS/giveitsmaller-sdks/tree/main/docs/typescript/examples)
61
+ Full documentation — getting started and concepts, the `GislClient` reference and operation
62
+ options, authoring primitives, SSE/live progress, webhooks, error/retry guidance, troubleshooting,
63
+ and per-operation examples lives at [giveitsmaller.com](https://giveitsmaller.com).
71
64
 
72
65
  ## Contributing: the committed `dist/`
73
66
 
@@ -92,4 +85,4 @@ the `file:` gap.
92
85
 
93
86
  ## License
94
87
 
95
- MIT — see the [LICENSE](https://github.com/AntonioCS/giveitsmaller-sdks/blob/main/LICENSE) file.
88
+ Apache-2.0 — see the [LICENSE](./LICENSE) file.
package/dist/_audit.js CHANGED
@@ -56,6 +56,8 @@ export function _runAudit() {
56
56
  accept();
57
57
  accept();
58
58
  accept();
59
+ accept();
60
+ accept();
59
61
  // SDK-3 (Wb6ebOMM) public-API surface for the 3 resume-support endpoints.
60
62
  accept();
61
63
  accept();
@@ -120,10 +122,6 @@ export function _runAudit() {
120
122
  accept();
121
123
  accept();
122
124
  accept();
123
- accept();
124
- accept();
125
- accept();
126
- accept();
127
125
  // T4b / 27rE1fZn — preset resolver public types.
128
126
  accept();
129
127
  accept();
@@ -139,6 +137,8 @@ export function _runAudit() {
139
137
  accept();
140
138
  // FF3a / u0hBt6fl — homogeneous fan-out builder surface.
141
139
  accept();
140
+ // FF7 / MFaCjL8d — keyed multi-recipe batch builder surface.
141
+ accept();
142
142
  // FF4a / Z7zTr789 — multi-input watermark recipe surface.
143
143
  accept();
144
144
  accept();
@@ -149,4 +149,14 @@ export function _runAudit() {
149
149
  // FF5a / Ao8RPVxD — file-first Handle reattach surface.
150
150
  accept();
151
151
  accept();
152
+ // TYNjcjpo — SSE parse-failure diagnostic surface.
153
+ accept();
154
+ // qUhxfDA5 — capabilities() projection surface + the three contract
155
+ // capability types it exposes.
156
+ accept();
157
+ accept();
158
+ accept();
159
+ accept();
160
+ // W8v4jWzx — error-taxonomy category union surfaced by GislApiError.category.
161
+ accept();
152
162
  }
package/dist/builder.d.ts CHANGED
@@ -21,13 +21,13 @@
21
21
  * `status` values pass through verbatim from `SseOperationProgressDataStatusEnum`.
22
22
  * The wire does NOT carry a `phase` field — see karen reality-check 2026-05-23.
23
23
  * - `.run()` requires `maxWait` (no default). The underlying `waitForWorkflow`
24
- * has a 300s default for the poll fallback path; the ergonomic layer makes
24
+ * has a 600s default for the poll fallback path; the ergonomic layer makes
25
25
  * it MANDATORY in the type so callers consciously choose a deadline.
26
26
  */
27
27
  import type { GislClient } from './client.js';
28
28
  import type { OperationDownload, WorkflowStatusResponse, SseOperationProgressDataStatusEnum } from '@giveitsmaller/contracts/openapi';
29
29
  import { Handle } from './handle.js';
30
- import type { PresetDefaults, PresetMedia } from './ergonomic/presets/index.js';
30
+ import type { PresetDefaults, DetectedMedia } from './ergonomic/presets/index.js';
31
31
  /**
32
32
  * Best-effort detection of the compress-operation media from the
33
33
  * builder's input. T4b only resolves presets for compress; the wire's
@@ -40,7 +40,7 @@ import type { PresetDefaults, PresetMedia } from './ergonomic/presets/index.js';
40
40
  *
41
41
  * @internal — exported for tests + the preset resolver.
42
42
  */
43
- export declare function _detectCompressMedia(input: string | Blob): PresetMedia | undefined;
43
+ export declare function _detectCompressMedia(input: string | Blob): DetectedMedia | undefined;
44
44
  /**
45
45
  * Best-effort classification of whether an audio input is LOSSLESS
46
46
  * (flac/wav) vs lossy. The worker rejects `bitrate` on lossless audio
@@ -217,6 +217,7 @@ export interface UploadProgressEvent {
217
217
  export interface ProcessingProgressEvent {
218
218
  readonly phase: 'processing';
219
219
  readonly status?: SseOperationProgressDataStatusEnum;
220
+ /** Percent complete, `0-100` (the wire integer) — NOT a 0..1 fraction. */
220
221
  readonly progress: number;
221
222
  readonly jobRef: string;
222
223
  readonly operationId: string;
@@ -235,7 +236,7 @@ export interface RunOptions {
235
236
  /**
236
237
  * Wall-clock deadline for the entire run (upload + create + wait + downloads).
237
238
  * MANDATORY — the SDK does NOT supply a default because the underlying
238
- * `waitForWorkflow` poll path has a 300s default that would otherwise
239
+ * `waitForWorkflow` poll path has a 600s default that would otherwise
239
240
  * leak silently. Pass `'2h'` / `'30m'` / `'120s'` as a string suffix or
240
241
  * a number of milliseconds.
241
242
  */
package/dist/builder.js CHANGED
@@ -21,7 +21,7 @@
21
21
  * `status` values pass through verbatim from `SseOperationProgressDataStatusEnum`.
22
22
  * The wire does NOT carry a `phase` field — see karen reality-check 2026-05-23.
23
23
  * - `.run()` requires `maxWait` (no default). The underlying `waitForWorkflow`
24
- * has a 300s default for the poll fallback path; the ergonomic layer makes
24
+ * has a 600s default for the poll fallback path; the ergonomic layer makes
25
25
  * it MANDATORY in the type so callers consciously choose a deadline.
26
26
  */
27
27
  import { SseEventType, SseOperationProgressDataFromJSON, } from '@giveitsmaller/contracts/openapi';
@@ -64,10 +64,10 @@ export function _detectCompressMedia(input) {
64
64
  return 'audio';
65
65
  if (mime.startsWith('video/'))
66
66
  return 'video';
67
- if (mime === 'application/pdf')
68
- return 'document_pdf';
69
67
  if (mime === 'application/epub+zip')
70
68
  return 'document_epub';
69
+ if (mime === 'application/pdf')
70
+ return 'document_pdf';
71
71
  if (mime === 'application/vnd.oasis.opendocument.text' ||
72
72
  mime === 'application/vnd.oasis.opendocument.spreadsheet' ||
73
73
  mime === 'application/vnd.oasis.opendocument.presentation') {
@@ -93,10 +93,10 @@ export function _detectCompressMedia(input) {
93
93
  return 'audio';
94
94
  if (['mp4', 'mov', 'mkv', 'webm', 'avi', 'wmv', 'flv', 'm4v'].includes(ext))
95
95
  return 'video';
96
- if (ext === 'pdf')
97
- return 'document_pdf';
98
96
  if (ext === 'epub')
99
97
  return 'document_epub';
98
+ if (ext === 'pdf')
99
+ return 'document_pdf';
100
100
  if (['odt', 'ods', 'odp'].includes(ext))
101
101
  return 'document_odf';
102
102
  if (['doc', 'docx', 'xls', 'xlsx', 'ppt', 'pptx'].includes(ext))
@@ -316,14 +316,14 @@ export class OperationBuilder {
316
316
  // the deadline before issuing the downloads request rather than letting
317
317
  // a slow getWorkflowDownloads silently exceed it.
318
318
  if (Date.now() >= deadline) {
319
- throw new GislTimeoutError(`Workflow ${created.workflowId} reached terminal status but maxWait elapsed before downloads could be fetched`);
319
+ throw new GislTimeoutError(`Workflow ${created.workflowId} reached terminal status but maxWait elapsed before downloads could be fetched`, created.workflowId);
320
320
  }
321
321
  const downloads = await this.client.getWorkflowDownloads(created.workflowId);
322
322
  // TDqmkWpX: the maxWait deadline also covers the downloads fetch itself — a
323
323
  // slow getWorkflowDownloads must not return a success after the advertised
324
324
  // whole-run deadline. Re-check AFTER the call (the check above is BEFORE).
325
325
  if (Date.now() >= deadline) {
326
- throw new GislTimeoutError(`Workflow ${created.workflowId} downloads fetch completed after maxWait elapsed`);
326
+ throw new GislTimeoutError(`Workflow ${created.workflowId} downloads fetch completed after maxWait elapsed`, created.workflowId);
327
327
  }
328
328
  return _projectResult(finalStatus, downloads.downloads, resolved.wireOptions, resolved.resolvedOptions);
329
329
  }
@@ -531,7 +531,7 @@ class _OnProgressThrew {
531
531
  export async function _consumeSseToTerminal(client, args) {
532
532
  const remainingMs = args.deadline - Date.now();
533
533
  if (remainingMs <= 0) {
534
- throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`);
534
+ throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`, args.workflowId);
535
535
  }
536
536
  const sseAbort = new AbortController();
537
537
  // Compose caller's signal + a SDK-internal one so we can tear down on terminal.
@@ -560,7 +560,7 @@ export async function _consumeSseToTerminal(client, args) {
560
560
  // If streamEvents rejected because the deadline-armed sseAbort fired
561
561
  // before/during connect, surface as timeout (not raw AbortError).
562
562
  if (deadlineExpired && err instanceof DOMException && err.name === 'AbortError') {
563
- throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`);
563
+ throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`, args.workflowId);
564
564
  }
565
565
  // TDqmkWpX: a genuine connect-phase TRANSPORT failure surfaces as a raw
566
566
  // `TypeError` from `fetch` (DNS/TCP/TLS) — wrap it as a typed
@@ -577,7 +577,7 @@ export async function _consumeSseToTerminal(client, args) {
577
577
  try {
578
578
  for await (const event of events) {
579
579
  if (deadlineExpired) {
580
- throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`);
580
+ throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`, args.workflowId);
581
581
  }
582
582
  if (args.onProgress !== undefined && event.event === SseEventType.operation_progress) {
583
583
  // Codex r1 high d6485d3e35f9 — `streamEvents` yields raw snake_case
@@ -620,13 +620,13 @@ export async function _consumeSseToTerminal(client, args) {
620
620
  }
621
621
  if (Date.now() >= args.deadline) {
622
622
  sseAbort.abort();
623
- throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`);
623
+ throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`, args.workflowId);
624
624
  }
625
625
  }
626
626
  // Stream ended cleanly without terminal. If the deadline timer fired
627
627
  // mid-stream and triggered the abort, surface that as the timeout.
628
628
  if (deadlineExpired) {
629
- throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`);
629
+ throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`, args.workflowId);
630
630
  }
631
631
  // Otherwise it was a clean server-side close — fall back to poll. TDqmkWpX:
632
632
  // a sealed marker (not a bare Error) so callers poll ONLY on this + a typed
@@ -646,7 +646,7 @@ export async function _consumeSseToTerminal(client, args) {
646
646
  if (deadlineExpired &&
647
647
  innerErr instanceof DOMException &&
648
648
  innerErr.name === 'AbortError') {
649
- throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`);
649
+ throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`, args.workflowId);
650
650
  }
651
651
  // A genuine mid-stream TRANSPORT failure (reader disconnect) surfaces as a
652
652
  // raw `TypeError` from the iterator — wrap as GislNetworkError so callers
@@ -686,7 +686,7 @@ export async function _pollToTerminal(client, args) {
686
686
  while (true) {
687
687
  _checkAborted(args.signal);
688
688
  if (Date.now() >= args.deadline) {
689
- throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`);
689
+ throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`, args.workflowId);
690
690
  }
691
691
  const status = await client.getWorkflowStatus(args.workflowId);
692
692
  if (TERMINAL_STATUS.has(status.status)) {
@@ -697,10 +697,10 @@ export async function _pollToTerminal(client, args) {
697
697
  // pre-fetch check firing. Without this, a small `pollIntervalMs` against
698
698
  // a slow API can busy-spin past the deadline arbitrarily.
699
699
  if (Date.now() >= args.deadline) {
700
- throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`);
700
+ throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`, args.workflowId);
701
701
  }
702
702
  if (Date.now() + intervalMs >= args.deadline) {
703
- throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`);
703
+ throw new GislTimeoutError(`Workflow ${args.workflowId} did not complete before maxWait deadline`, args.workflowId);
704
704
  }
705
705
  await sleep(intervalMs, args.signal);
706
706
  }
package/dist/client.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import type { AudioWatermarkDecodeRequest, AudioWatermarkDecodeResponse, ExternalImportCreatedResponse, ExternalImportRequest, LoginUserRequest, LoginUser200ResponseData, ContactRequest, AccountLimits, CreditsBalanceResponse, CreditsUsageResponse, UploadResponse, UploadProbeResponse, WorkflowCancelResponse, WorkflowCreateResponse, WorkflowResumeResponse, WorkflowStatusResponse, WorkflowListResponse, WorkflowSummary, WorkflowDownloadResponse, MetadataResponse, RetryResponse } from '@giveitsmaller/contracts/openapi';
2
- import type { CreditsUsageOptions, ListWorkflowsOptions, GetSchemaOptions, GetSchemaResult, GislClientConfig, GislSseEvent, PreflightClipsResult, ProbeWaitOptions, ProbeWaitResult, ReadCapabilityOptions, UploadOptions, WaitOptions, WorkflowCreatePayload, _Sdk3HandCodedKeepaliveResult, _Sdk3HandCodedMultipartStatusResult, _Sdk3HandCodedPresignPartsResult } from './types.js';
2
+ import type { CreditsUsageOptions, ListWorkflowsOptions, GetSchemaOptions, GetSchemaResult, GislClientConfig, GislSseEvent, GislSseParseFailure, PreflightClipsResult, ProbeWaitOptions, ProbeWaitResult, ReadCapabilityOptions, UploadOptions, WaitOptions, WorkflowCreatePayload, _Sdk3HandCodedKeepaliveResult, _Sdk3HandCodedMultipartStatusResult, _Sdk3HandCodedPresignPartsResult } from './types.js';
3
3
  export declare const MULTIPART_CONCURRENCY_DEFAULT: 4;
4
4
  export declare const DEFAULT_MULTIPART_FIRST_CHUNK_SIZE: number;
5
5
  export interface ValidationDetail {
@@ -199,6 +199,13 @@ export declare class GislClient {
199
199
  streamEvents(workflowId: string, opts?: {
200
200
  signal?: AbortSignal;
201
201
  capability?: string;
202
+ /**
203
+ * Observe malformed-JSON SSE frames (TYNjcjpo). A frame whose `data:` body
204
+ * fails to parse is SKIPPED from the stream (kept resilient) and reported
205
+ * here as a typed {@link GislSseParseFailure} instead of being silently lost.
206
+ * Omit to drop malformed frames silently (the default; PHP parity).
207
+ */
208
+ onParseError?: (diagnostic: GislSseParseFailure) => void;
202
209
  }): Promise<AsyncGenerator<GislSseEvent>>;
203
210
  /**
204
211
  * Get metadata for an uploaded file.
@@ -258,15 +265,18 @@ export declare class GislClient {
258
265
  * via that cookie when the client is configured with
259
266
  * `useSessionCookie: true`.
260
267
  *
261
- * Failure modes per ticket FX6mbTJD:
262
- * - **401** `invalid_credentials` (collapsed with unverified
263
- * accounts for anti-enumeration) `GislAuthError`.
264
- * - **403** account-state failures (`account_locked`,
265
- * `account_disabled`, `account_deleted`,
266
- * `account_deletion_expired`) → `GislAuthError`.
268
+ * Failure modes per ticket FX6mbTJD (login narrowed at contracts
269
+ * v2.166.0 authsec no 403 account-state branch on login):
270
+ * - **401** `invalid_credentials` (wrong password, unverified, OR
271
+ * unknown account all collapsed for anti-enumeration)
272
+ * `GislAuthError`.
267
273
  * - **429** infrastructure rate-limit → `GislApiError` with
268
274
  * the `Retry-After` header echoed on the response.
269
275
  *
276
+ * The account-status error types (`account_locked` / `account_disabled`
277
+ * / `account_deleted` / `account_deletion_expired`) still exist but are
278
+ * emitted on the API-key path + live-session enforcement, not on login.
279
+ *
270
280
  * Node session persistence (cookie-jar across processes) is out of
271
281
  * scope — this method only touches the request side.
272
282
  */