@scalemule/sdk 0.0.15 → 0.0.18
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.
- package/dist/flags/server.d.mts +6 -1
- package/dist/flags/server.d.ts +6 -1
- package/dist/flags/server.js +58 -29
- package/dist/flags/server.mjs +58 -29
- package/dist/index.d.mts +90 -1
- package/dist/index.d.ts +90 -1
- package/dist/index.js +380 -7
- package/dist/index.mjs +378 -7
- package/package.json +1 -1
package/dist/flags/server.d.mts
CHANGED
|
@@ -79,6 +79,8 @@ declare class FlagClient {
|
|
|
79
79
|
private environment;
|
|
80
80
|
private gatewayUrl;
|
|
81
81
|
private config;
|
|
82
|
+
private flagIndex;
|
|
83
|
+
private segmentIndex;
|
|
82
84
|
private lastETag;
|
|
83
85
|
private streamState;
|
|
84
86
|
private pollTimer;
|
|
@@ -87,9 +89,12 @@ declare class FlagClient {
|
|
|
87
89
|
private abortController;
|
|
88
90
|
private initPromise;
|
|
89
91
|
private telemetryCounters;
|
|
92
|
+
private isShuttingDown;
|
|
93
|
+
private streamConnectInFlight;
|
|
90
94
|
constructor(options: FlagClientOptions);
|
|
91
95
|
init(): Promise<void>;
|
|
92
96
|
private doInit;
|
|
97
|
+
private buildIndexes;
|
|
93
98
|
evaluate(flagKey: string, context: EvaluationContext): FlagEvaluation;
|
|
94
99
|
evaluateBatch(flagKeys: string[], context: EvaluationContext): Record<string, FlagEvaluation>;
|
|
95
100
|
shutdown(): Promise<void>;
|
|
@@ -108,7 +113,7 @@ declare class FlagClient {
|
|
|
108
113
|
* Produces identical results to the server-side evaluation.
|
|
109
114
|
*/
|
|
110
115
|
|
|
111
|
-
declare function evaluateFlag(flag: FlagWire, config: FlagConfigWire, context: EvaluationContext): FlagEvaluation;
|
|
116
|
+
declare function evaluateFlag(flag: FlagWire, config: FlagConfigWire, context: EvaluationContext, segmentIndex?: Map<string, SegmentWire>): FlagEvaluation;
|
|
112
117
|
|
|
113
118
|
/**
|
|
114
119
|
* Hash-to-bucket matching Rust: SHA256(salt.flag_key.identifier) → first 4 bytes → u32 BE → mod 10_000
|
package/dist/flags/server.d.ts
CHANGED
|
@@ -79,6 +79,8 @@ declare class FlagClient {
|
|
|
79
79
|
private environment;
|
|
80
80
|
private gatewayUrl;
|
|
81
81
|
private config;
|
|
82
|
+
private flagIndex;
|
|
83
|
+
private segmentIndex;
|
|
82
84
|
private lastETag;
|
|
83
85
|
private streamState;
|
|
84
86
|
private pollTimer;
|
|
@@ -87,9 +89,12 @@ declare class FlagClient {
|
|
|
87
89
|
private abortController;
|
|
88
90
|
private initPromise;
|
|
89
91
|
private telemetryCounters;
|
|
92
|
+
private isShuttingDown;
|
|
93
|
+
private streamConnectInFlight;
|
|
90
94
|
constructor(options: FlagClientOptions);
|
|
91
95
|
init(): Promise<void>;
|
|
92
96
|
private doInit;
|
|
97
|
+
private buildIndexes;
|
|
93
98
|
evaluate(flagKey: string, context: EvaluationContext): FlagEvaluation;
|
|
94
99
|
evaluateBatch(flagKeys: string[], context: EvaluationContext): Record<string, FlagEvaluation>;
|
|
95
100
|
shutdown(): Promise<void>;
|
|
@@ -108,7 +113,7 @@ declare class FlagClient {
|
|
|
108
113
|
* Produces identical results to the server-side evaluation.
|
|
109
114
|
*/
|
|
110
115
|
|
|
111
|
-
declare function evaluateFlag(flag: FlagWire, config: FlagConfigWire, context: EvaluationContext): FlagEvaluation;
|
|
116
|
+
declare function evaluateFlag(flag: FlagWire, config: FlagConfigWire, context: EvaluationContext, segmentIndex?: Map<string, SegmentWire>): FlagEvaluation;
|
|
112
117
|
|
|
113
118
|
/**
|
|
114
119
|
* Hash-to-bucket matching Rust: SHA256(salt.flag_key.identifier) → first 4 bytes → u32 BE → mod 10_000
|
package/dist/flags/server.js
CHANGED
|
@@ -181,7 +181,7 @@ function semverCmp(actual, expected) {
|
|
|
181
181
|
}
|
|
182
182
|
|
|
183
183
|
// src/flags/evaluator.ts
|
|
184
|
-
function evaluateFlag(flag, config, context) {
|
|
184
|
+
function evaluateFlag(flag, config, context, segmentIndex) {
|
|
185
185
|
const effectiveDefault = flag.environment_default_value ?? flag.default_value;
|
|
186
186
|
if (flag.status !== "active") {
|
|
187
187
|
return result(flag, config.environment, effectiveDefault, "disabled");
|
|
@@ -194,7 +194,7 @@ function evaluateFlag(flag, config, context) {
|
|
|
194
194
|
if (!rule.enabled) continue;
|
|
195
195
|
if (rule.segment_ids.length > 0) {
|
|
196
196
|
const segmentMatched = rule.segment_ids.some((segId) => {
|
|
197
|
-
const segment = config.segments.find((s) => s.id === segId);
|
|
197
|
+
const segment = segmentIndex ? segmentIndex.get(segId) : config.segments.find((s) => s.id === segId);
|
|
198
198
|
if (!segment) return false;
|
|
199
199
|
return userMatchesSegment(segment, context);
|
|
200
200
|
});
|
|
@@ -283,6 +283,8 @@ function result(flag, environment, value, reason) {
|
|
|
283
283
|
var FlagClient = class {
|
|
284
284
|
constructor(options) {
|
|
285
285
|
this.config = null;
|
|
286
|
+
this.flagIndex = /* @__PURE__ */ new Map();
|
|
287
|
+
this.segmentIndex = /* @__PURE__ */ new Map();
|
|
286
288
|
this.lastETag = "";
|
|
287
289
|
this.streamState = "idle";
|
|
288
290
|
this.pollTimer = null;
|
|
@@ -291,11 +293,14 @@ var FlagClient = class {
|
|
|
291
293
|
this.abortController = null;
|
|
292
294
|
this.initPromise = null;
|
|
293
295
|
this.telemetryCounters = /* @__PURE__ */ new Map();
|
|
296
|
+
this.isShuttingDown = false;
|
|
297
|
+
this.streamConnectInFlight = false;
|
|
294
298
|
this.apiKey = options.apiKey;
|
|
295
299
|
this.environment = options.environment;
|
|
296
300
|
this.gatewayUrl = options.gatewayUrl;
|
|
297
301
|
}
|
|
298
302
|
async init() {
|
|
303
|
+
this.isShuttingDown = false;
|
|
299
304
|
if (this.config) return;
|
|
300
305
|
if (this.initPromise) return this.initPromise;
|
|
301
306
|
this.initPromise = this.doInit();
|
|
@@ -313,13 +318,25 @@ var FlagClient = class {
|
|
|
313
318
|
if (!resp.ok) throw new Error(`Config fetch failed: ${resp.status}`);
|
|
314
319
|
const json = await resp.json();
|
|
315
320
|
this.config = json.data;
|
|
321
|
+
this.buildIndexes();
|
|
316
322
|
this.lastETag = resp.headers.get("etag") || "";
|
|
317
323
|
this.connectStream();
|
|
318
324
|
this.startTelemetryFlush();
|
|
319
325
|
}
|
|
326
|
+
buildIndexes() {
|
|
327
|
+
this.flagIndex.clear();
|
|
328
|
+
this.segmentIndex.clear();
|
|
329
|
+
if (!this.config) return;
|
|
330
|
+
for (const flag of this.config.flags) {
|
|
331
|
+
this.flagIndex.set(flag.flag_key, flag);
|
|
332
|
+
}
|
|
333
|
+
for (const segment of this.config.segments) {
|
|
334
|
+
this.segmentIndex.set(segment.id, segment);
|
|
335
|
+
}
|
|
336
|
+
}
|
|
320
337
|
evaluate(flagKey, context) {
|
|
321
338
|
if (!this.config) throw new Error("FlagClient not initialized \u2014 call init() first");
|
|
322
|
-
const flagConfig = this.
|
|
339
|
+
const flagConfig = this.flagIndex.get(flagKey);
|
|
323
340
|
if (!flagConfig) {
|
|
324
341
|
return {
|
|
325
342
|
flag_id: "",
|
|
@@ -332,7 +349,7 @@ var FlagClient = class {
|
|
|
332
349
|
bucket: null
|
|
333
350
|
};
|
|
334
351
|
}
|
|
335
|
-
const result2 = evaluateFlag(flagConfig, this.config, context);
|
|
352
|
+
const result2 = evaluateFlag(flagConfig, this.config, context, this.segmentIndex);
|
|
336
353
|
this.recordTelemetry(result2);
|
|
337
354
|
return result2;
|
|
338
355
|
}
|
|
@@ -340,9 +357,9 @@ var FlagClient = class {
|
|
|
340
357
|
if (!this.config) throw new Error("FlagClient not initialized \u2014 call init() first");
|
|
341
358
|
const results = {};
|
|
342
359
|
for (const key of flagKeys) {
|
|
343
|
-
const flagConfig = this.
|
|
360
|
+
const flagConfig = this.flagIndex.get(key);
|
|
344
361
|
if (flagConfig) {
|
|
345
|
-
const result2 = evaluateFlag(flagConfig, this.config, context);
|
|
362
|
+
const result2 = evaluateFlag(flagConfig, this.config, context, this.segmentIndex);
|
|
346
363
|
this.recordTelemetry(result2);
|
|
347
364
|
results[key] = result2;
|
|
348
365
|
}
|
|
@@ -350,6 +367,7 @@ var FlagClient = class {
|
|
|
350
367
|
return results;
|
|
351
368
|
}
|
|
352
369
|
async shutdown() {
|
|
370
|
+
this.isShuttingDown = true;
|
|
353
371
|
this.streamState = "idle";
|
|
354
372
|
this.abortController?.abort();
|
|
355
373
|
this.abortController = null;
|
|
@@ -369,9 +387,13 @@ var FlagClient = class {
|
|
|
369
387
|
}
|
|
370
388
|
// ======== SSE Streaming ========
|
|
371
389
|
async connectStream() {
|
|
372
|
-
if (this.streamState === "streaming") return;
|
|
390
|
+
if (this.isShuttingDown || this.streamState === "streaming" || this.streamConnectInFlight) return;
|
|
391
|
+
this.streamConnectInFlight = true;
|
|
373
392
|
this.abortController?.abort();
|
|
374
|
-
|
|
393
|
+
const abortController = new AbortController();
|
|
394
|
+
this.abortController = abortController;
|
|
395
|
+
const shouldResumePolling = this.streamState !== "polling";
|
|
396
|
+
let startPolling = shouldResumePolling;
|
|
375
397
|
try {
|
|
376
398
|
const resp = await fetch(
|
|
377
399
|
`${this.gatewayUrl}/v1/flags/stream?environment=${encodeURIComponent(this.environment)}`,
|
|
@@ -380,33 +402,38 @@ var FlagClient = class {
|
|
|
380
402
|
"x-api-key": this.apiKey,
|
|
381
403
|
"Last-Event-ID": String(this.config?.version ?? 0)
|
|
382
404
|
},
|
|
383
|
-
signal:
|
|
405
|
+
signal: abortController.signal
|
|
384
406
|
}
|
|
385
407
|
);
|
|
386
|
-
if (
|
|
387
|
-
this.
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
408
|
+
if (resp.ok && resp.body) {
|
|
409
|
+
this.streamState = "streaming";
|
|
410
|
+
this.stopPolling();
|
|
411
|
+
startPolling = false;
|
|
412
|
+
const reader = resp.body.getReader();
|
|
413
|
+
const decoder = new TextDecoder();
|
|
414
|
+
let buffer = "";
|
|
415
|
+
while (true) {
|
|
416
|
+
const { done, value } = await reader.read();
|
|
417
|
+
if (done) break;
|
|
418
|
+
buffer += decoder.decode(value, { stream: true });
|
|
419
|
+
let idx;
|
|
420
|
+
while ((idx = buffer.indexOf("\n\n")) !== -1) {
|
|
421
|
+
const frame = buffer.slice(0, idx);
|
|
422
|
+
buffer = buffer.slice(idx + 2);
|
|
423
|
+
this.handleSseFrame(frame);
|
|
424
|
+
}
|
|
425
|
+
}
|
|
426
|
+
if (this.streamState === "streaming") {
|
|
427
|
+
this.streamState = "idle";
|
|
428
|
+
startPolling = true;
|
|
404
429
|
}
|
|
405
430
|
}
|
|
406
431
|
} catch {
|
|
432
|
+
startPolling = !abortController.signal.aborted && shouldResumePolling;
|
|
433
|
+
} finally {
|
|
434
|
+
this.streamConnectInFlight = false;
|
|
407
435
|
}
|
|
408
|
-
if (this.
|
|
409
|
-
this.streamState = "idle";
|
|
436
|
+
if (!this.isShuttingDown && startPolling) {
|
|
410
437
|
this.startPolling();
|
|
411
438
|
}
|
|
412
439
|
}
|
|
@@ -423,6 +450,7 @@ var FlagClient = class {
|
|
|
423
450
|
const newConfig = parsed.data;
|
|
424
451
|
if (newConfig && newConfig.version !== void 0) {
|
|
425
452
|
this.config = newConfig;
|
|
453
|
+
this.buildIndexes();
|
|
426
454
|
}
|
|
427
455
|
} catch {
|
|
428
456
|
}
|
|
@@ -457,6 +485,7 @@ var FlagClient = class {
|
|
|
457
485
|
if (!resp.ok) return;
|
|
458
486
|
const json = await resp.json();
|
|
459
487
|
this.config = json.data;
|
|
488
|
+
this.buildIndexes();
|
|
460
489
|
this.lastETag = resp.headers.get("etag") || "";
|
|
461
490
|
} catch {
|
|
462
491
|
}
|
package/dist/flags/server.mjs
CHANGED
|
@@ -152,7 +152,7 @@ function semverCmp(actual, expected) {
|
|
|
152
152
|
}
|
|
153
153
|
|
|
154
154
|
// src/flags/evaluator.ts
|
|
155
|
-
function evaluateFlag(flag, config, context) {
|
|
155
|
+
function evaluateFlag(flag, config, context, segmentIndex) {
|
|
156
156
|
const effectiveDefault = flag.environment_default_value ?? flag.default_value;
|
|
157
157
|
if (flag.status !== "active") {
|
|
158
158
|
return result(flag, config.environment, effectiveDefault, "disabled");
|
|
@@ -165,7 +165,7 @@ function evaluateFlag(flag, config, context) {
|
|
|
165
165
|
if (!rule.enabled) continue;
|
|
166
166
|
if (rule.segment_ids.length > 0) {
|
|
167
167
|
const segmentMatched = rule.segment_ids.some((segId) => {
|
|
168
|
-
const segment = config.segments.find((s) => s.id === segId);
|
|
168
|
+
const segment = segmentIndex ? segmentIndex.get(segId) : config.segments.find((s) => s.id === segId);
|
|
169
169
|
if (!segment) return false;
|
|
170
170
|
return userMatchesSegment(segment, context);
|
|
171
171
|
});
|
|
@@ -254,6 +254,8 @@ function result(flag, environment, value, reason) {
|
|
|
254
254
|
var FlagClient = class {
|
|
255
255
|
constructor(options) {
|
|
256
256
|
this.config = null;
|
|
257
|
+
this.flagIndex = /* @__PURE__ */ new Map();
|
|
258
|
+
this.segmentIndex = /* @__PURE__ */ new Map();
|
|
257
259
|
this.lastETag = "";
|
|
258
260
|
this.streamState = "idle";
|
|
259
261
|
this.pollTimer = null;
|
|
@@ -262,11 +264,14 @@ var FlagClient = class {
|
|
|
262
264
|
this.abortController = null;
|
|
263
265
|
this.initPromise = null;
|
|
264
266
|
this.telemetryCounters = /* @__PURE__ */ new Map();
|
|
267
|
+
this.isShuttingDown = false;
|
|
268
|
+
this.streamConnectInFlight = false;
|
|
265
269
|
this.apiKey = options.apiKey;
|
|
266
270
|
this.environment = options.environment;
|
|
267
271
|
this.gatewayUrl = options.gatewayUrl;
|
|
268
272
|
}
|
|
269
273
|
async init() {
|
|
274
|
+
this.isShuttingDown = false;
|
|
270
275
|
if (this.config) return;
|
|
271
276
|
if (this.initPromise) return this.initPromise;
|
|
272
277
|
this.initPromise = this.doInit();
|
|
@@ -284,13 +289,25 @@ var FlagClient = class {
|
|
|
284
289
|
if (!resp.ok) throw new Error(`Config fetch failed: ${resp.status}`);
|
|
285
290
|
const json = await resp.json();
|
|
286
291
|
this.config = json.data;
|
|
292
|
+
this.buildIndexes();
|
|
287
293
|
this.lastETag = resp.headers.get("etag") || "";
|
|
288
294
|
this.connectStream();
|
|
289
295
|
this.startTelemetryFlush();
|
|
290
296
|
}
|
|
297
|
+
buildIndexes() {
|
|
298
|
+
this.flagIndex.clear();
|
|
299
|
+
this.segmentIndex.clear();
|
|
300
|
+
if (!this.config) return;
|
|
301
|
+
for (const flag of this.config.flags) {
|
|
302
|
+
this.flagIndex.set(flag.flag_key, flag);
|
|
303
|
+
}
|
|
304
|
+
for (const segment of this.config.segments) {
|
|
305
|
+
this.segmentIndex.set(segment.id, segment);
|
|
306
|
+
}
|
|
307
|
+
}
|
|
291
308
|
evaluate(flagKey, context) {
|
|
292
309
|
if (!this.config) throw new Error("FlagClient not initialized \u2014 call init() first");
|
|
293
|
-
const flagConfig = this.
|
|
310
|
+
const flagConfig = this.flagIndex.get(flagKey);
|
|
294
311
|
if (!flagConfig) {
|
|
295
312
|
return {
|
|
296
313
|
flag_id: "",
|
|
@@ -303,7 +320,7 @@ var FlagClient = class {
|
|
|
303
320
|
bucket: null
|
|
304
321
|
};
|
|
305
322
|
}
|
|
306
|
-
const result2 = evaluateFlag(flagConfig, this.config, context);
|
|
323
|
+
const result2 = evaluateFlag(flagConfig, this.config, context, this.segmentIndex);
|
|
307
324
|
this.recordTelemetry(result2);
|
|
308
325
|
return result2;
|
|
309
326
|
}
|
|
@@ -311,9 +328,9 @@ var FlagClient = class {
|
|
|
311
328
|
if (!this.config) throw new Error("FlagClient not initialized \u2014 call init() first");
|
|
312
329
|
const results = {};
|
|
313
330
|
for (const key of flagKeys) {
|
|
314
|
-
const flagConfig = this.
|
|
331
|
+
const flagConfig = this.flagIndex.get(key);
|
|
315
332
|
if (flagConfig) {
|
|
316
|
-
const result2 = evaluateFlag(flagConfig, this.config, context);
|
|
333
|
+
const result2 = evaluateFlag(flagConfig, this.config, context, this.segmentIndex);
|
|
317
334
|
this.recordTelemetry(result2);
|
|
318
335
|
results[key] = result2;
|
|
319
336
|
}
|
|
@@ -321,6 +338,7 @@ var FlagClient = class {
|
|
|
321
338
|
return results;
|
|
322
339
|
}
|
|
323
340
|
async shutdown() {
|
|
341
|
+
this.isShuttingDown = true;
|
|
324
342
|
this.streamState = "idle";
|
|
325
343
|
this.abortController?.abort();
|
|
326
344
|
this.abortController = null;
|
|
@@ -340,9 +358,13 @@ var FlagClient = class {
|
|
|
340
358
|
}
|
|
341
359
|
// ======== SSE Streaming ========
|
|
342
360
|
async connectStream() {
|
|
343
|
-
if (this.streamState === "streaming") return;
|
|
361
|
+
if (this.isShuttingDown || this.streamState === "streaming" || this.streamConnectInFlight) return;
|
|
362
|
+
this.streamConnectInFlight = true;
|
|
344
363
|
this.abortController?.abort();
|
|
345
|
-
|
|
364
|
+
const abortController = new AbortController();
|
|
365
|
+
this.abortController = abortController;
|
|
366
|
+
const shouldResumePolling = this.streamState !== "polling";
|
|
367
|
+
let startPolling = shouldResumePolling;
|
|
346
368
|
try {
|
|
347
369
|
const resp = await fetch(
|
|
348
370
|
`${this.gatewayUrl}/v1/flags/stream?environment=${encodeURIComponent(this.environment)}`,
|
|
@@ -351,33 +373,38 @@ var FlagClient = class {
|
|
|
351
373
|
"x-api-key": this.apiKey,
|
|
352
374
|
"Last-Event-ID": String(this.config?.version ?? 0)
|
|
353
375
|
},
|
|
354
|
-
signal:
|
|
376
|
+
signal: abortController.signal
|
|
355
377
|
}
|
|
356
378
|
);
|
|
357
|
-
if (
|
|
358
|
-
this.
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
379
|
+
if (resp.ok && resp.body) {
|
|
380
|
+
this.streamState = "streaming";
|
|
381
|
+
this.stopPolling();
|
|
382
|
+
startPolling = false;
|
|
383
|
+
const reader = resp.body.getReader();
|
|
384
|
+
const decoder = new TextDecoder();
|
|
385
|
+
let buffer = "";
|
|
386
|
+
while (true) {
|
|
387
|
+
const { done, value } = await reader.read();
|
|
388
|
+
if (done) break;
|
|
389
|
+
buffer += decoder.decode(value, { stream: true });
|
|
390
|
+
let idx;
|
|
391
|
+
while ((idx = buffer.indexOf("\n\n")) !== -1) {
|
|
392
|
+
const frame = buffer.slice(0, idx);
|
|
393
|
+
buffer = buffer.slice(idx + 2);
|
|
394
|
+
this.handleSseFrame(frame);
|
|
395
|
+
}
|
|
396
|
+
}
|
|
397
|
+
if (this.streamState === "streaming") {
|
|
398
|
+
this.streamState = "idle";
|
|
399
|
+
startPolling = true;
|
|
375
400
|
}
|
|
376
401
|
}
|
|
377
402
|
} catch {
|
|
403
|
+
startPolling = !abortController.signal.aborted && shouldResumePolling;
|
|
404
|
+
} finally {
|
|
405
|
+
this.streamConnectInFlight = false;
|
|
378
406
|
}
|
|
379
|
-
if (this.
|
|
380
|
-
this.streamState = "idle";
|
|
407
|
+
if (!this.isShuttingDown && startPolling) {
|
|
381
408
|
this.startPolling();
|
|
382
409
|
}
|
|
383
410
|
}
|
|
@@ -394,6 +421,7 @@ var FlagClient = class {
|
|
|
394
421
|
const newConfig = parsed.data;
|
|
395
422
|
if (newConfig && newConfig.version !== void 0) {
|
|
396
423
|
this.config = newConfig;
|
|
424
|
+
this.buildIndexes();
|
|
397
425
|
}
|
|
398
426
|
} catch {
|
|
399
427
|
}
|
|
@@ -428,6 +456,7 @@ var FlagClient = class {
|
|
|
428
456
|
if (!resp.ok) return;
|
|
429
457
|
const json = await resp.json();
|
|
430
458
|
this.config = json.data;
|
|
459
|
+
this.buildIndexes();
|
|
431
460
|
this.lastETag = resp.headers.get("etag") || "";
|
|
432
461
|
} catch {
|
|
433
462
|
}
|
package/dist/index.d.mts
CHANGED
|
@@ -881,6 +881,21 @@ interface UploadCompleteResponse {
|
|
|
881
881
|
already_completed: boolean;
|
|
882
882
|
scan_queued: boolean;
|
|
883
883
|
}
|
|
884
|
+
interface UploadFailureReport {
|
|
885
|
+
fileId: string;
|
|
886
|
+
completionToken: string;
|
|
887
|
+
step: string;
|
|
888
|
+
errorCode: string;
|
|
889
|
+
errorMessage?: string;
|
|
890
|
+
httpStatus?: number;
|
|
891
|
+
attempt?: number;
|
|
892
|
+
diagnostics?: Record<string, unknown>;
|
|
893
|
+
}
|
|
894
|
+
interface UploadFailureReportResponse {
|
|
895
|
+
file_id: string;
|
|
896
|
+
recorded: boolean;
|
|
897
|
+
upload_status: string;
|
|
898
|
+
}
|
|
884
899
|
interface MultipartStartResponse {
|
|
885
900
|
upload_session_id: string;
|
|
886
901
|
file_id: string;
|
|
@@ -947,6 +962,7 @@ declare class StorageService extends ServiceModule {
|
|
|
947
962
|
getUploadUrl(filename: string, contentType: string, options?: {
|
|
948
963
|
isPublic?: boolean;
|
|
949
964
|
expiresIn?: number;
|
|
965
|
+
sizeBytes?: number;
|
|
950
966
|
metadata?: Record<string, unknown>;
|
|
951
967
|
}, requestOptions?: RequestOptions): Promise<ApiResponse<PresignedUploadResponse>>;
|
|
952
968
|
/**
|
|
@@ -957,6 +973,11 @@ declare class StorageService extends ServiceModule {
|
|
|
957
973
|
sizeBytes?: number;
|
|
958
974
|
checksum?: string;
|
|
959
975
|
}, requestOptions?: RequestOptions): Promise<ApiResponse<UploadCompleteResponse>>;
|
|
976
|
+
/**
|
|
977
|
+
* Persist a structured client-side upload failure against a file record.
|
|
978
|
+
* Best used by split-upload clients that call getUploadUrl() manually.
|
|
979
|
+
*/
|
|
980
|
+
reportUploadFailure(params: UploadFailureReport, requestOptions?: RequestOptions): Promise<ApiResponse<UploadFailureReportResponse>>;
|
|
960
981
|
/** Start a multipart upload session. */
|
|
961
982
|
startMultipartUpload(params: {
|
|
962
983
|
filename: string;
|
|
@@ -1050,6 +1071,7 @@ declare class StorageService extends ServiceModule {
|
|
|
1050
1071
|
private defaultChunkSize;
|
|
1051
1072
|
private defaultConcurrency;
|
|
1052
1073
|
private maybeCompress;
|
|
1074
|
+
private reportUploadFailureBestEffort;
|
|
1053
1075
|
private getOrCreateTelemetry;
|
|
1054
1076
|
/** Build RequestOptions with X-Upload-Session-Id header for cross-boundary correlation */
|
|
1055
1077
|
private withSessionHeader;
|
|
@@ -1252,6 +1274,73 @@ declare function getPartRange(partNumber: number, chunkSize: number, totalSize:
|
|
|
1252
1274
|
size: number;
|
|
1253
1275
|
};
|
|
1254
1276
|
|
|
1277
|
+
/**
|
|
1278
|
+
* Standalone S3 upload utilities for browser environments.
|
|
1279
|
+
*
|
|
1280
|
+
* These functions handle the client-side portion of presigned URL uploads:
|
|
1281
|
+
* - Single PUT for small files (with retry + stall detection)
|
|
1282
|
+
* - Multipart chunked upload for large files (parallel parts, per-chunk retry, ETag collection)
|
|
1283
|
+
*
|
|
1284
|
+
* Used by any app that gets presigned URLs from the server and needs to upload to S3.
|
|
1285
|
+
* The server-side proxy routes are app-specific; these utilities are app-agnostic.
|
|
1286
|
+
*/
|
|
1287
|
+
interface S3UploadProgress {
|
|
1288
|
+
loaded: number;
|
|
1289
|
+
total: number;
|
|
1290
|
+
percentage: number;
|
|
1291
|
+
}
|
|
1292
|
+
interface S3SingleUploadOptions {
|
|
1293
|
+
onProgress?: (progress: S3UploadProgress) => void;
|
|
1294
|
+
signal?: AbortSignal;
|
|
1295
|
+
/** Max retries per attempt (default: 3) */
|
|
1296
|
+
maxRetries?: number;
|
|
1297
|
+
/** Stall timeout in ms — abort if no progress for this long (default: 45000) */
|
|
1298
|
+
stallTimeoutMs?: number;
|
|
1299
|
+
}
|
|
1300
|
+
interface S3SingleUploadResult {
|
|
1301
|
+
success: boolean;
|
|
1302
|
+
error?: string;
|
|
1303
|
+
}
|
|
1304
|
+
interface MultipartPartUrl {
|
|
1305
|
+
partNumber: number;
|
|
1306
|
+
url: string;
|
|
1307
|
+
}
|
|
1308
|
+
interface MultipartConfig {
|
|
1309
|
+
partSizeBytes: number;
|
|
1310
|
+
totalParts: number;
|
|
1311
|
+
partUrls: MultipartPartUrl[];
|
|
1312
|
+
/** Fetch fresh URLs when needed (e.g., on 403 expiry). App provides this via its proxy route. */
|
|
1313
|
+
fetchMoreUrls?: (partNumbers: number[]) => Promise<MultipartPartUrl[] | null>;
|
|
1314
|
+
}
|
|
1315
|
+
interface S3MultipartOptions {
|
|
1316
|
+
onProgress?: (progress: S3UploadProgress) => void;
|
|
1317
|
+
signal?: AbortSignal;
|
|
1318
|
+
/** Max concurrent part uploads (default: 3) */
|
|
1319
|
+
concurrency?: number;
|
|
1320
|
+
/** Max retries per part (default: 3) */
|
|
1321
|
+
maxRetries?: number;
|
|
1322
|
+
}
|
|
1323
|
+
interface PartResult {
|
|
1324
|
+
partNumber: number;
|
|
1325
|
+
etag: string;
|
|
1326
|
+
}
|
|
1327
|
+
interface S3MultipartResult {
|
|
1328
|
+
success: boolean;
|
|
1329
|
+
parts?: PartResult[];
|
|
1330
|
+
error?: string;
|
|
1331
|
+
}
|
|
1332
|
+
/**
|
|
1333
|
+
* Upload a file to S3 via a single presigned PUT.
|
|
1334
|
+
* Includes retry on 5xx/network errors and stall detection.
|
|
1335
|
+
*/
|
|
1336
|
+
declare function uploadSingleToS3(url: string, file: File | Blob, options?: S3SingleUploadOptions): Promise<S3SingleUploadResult>;
|
|
1337
|
+
/**
|
|
1338
|
+
* Upload a file to S3 using multipart chunked upload.
|
|
1339
|
+
* Splits the file into chunks, uploads in parallel with per-chunk retry,
|
|
1340
|
+
* collects ETags for completion.
|
|
1341
|
+
*/
|
|
1342
|
+
declare function uploadMultipartToS3(file: File | Blob, config: MultipartConfig, options?: S3MultipartOptions): Promise<S3MultipartResult>;
|
|
1343
|
+
|
|
1255
1344
|
/**
|
|
1256
1345
|
* Realtime Service Module
|
|
1257
1346
|
*
|
|
@@ -5152,4 +5241,4 @@ declare class ScaleMule {
|
|
|
5152
5241
|
getClient(): ScaleMuleClient;
|
|
5153
5242
|
}
|
|
5154
5243
|
|
|
5155
|
-
export { type AccountBalance, AccountsService, type ActiveUsers, type ActivityItem, AgentAuthService, AgentModelsService, type AgentProfile, AgentProjectsService, type AgentResponse, type AgentSecurityPolicy, AgentSessionsService, type AgentSigningKey, type AgentToken, type AgentToolEntitlement, AgentToolsService, type Workspace as AgentWorkspace, AgentsService, type AggregateOptions, type AggregateResult, type AnalyticsEvent, AnalyticsService, type ApiError, type ApiKey, type ApiResponse, type Appeal, type Application, type Attachment, type Attendee, type AuditLog, type AuthRegisterAgentRequest, type AuthRegisterAgentResponse, AuthService, type AuthSession, type AuthUser, type BackupCodes, BillingService, type CacheEntry, CacheService, type CalendarEvent, type CatalogEntry, CatalogService, type ChatMessage, type ChatReaction, ChatService, type ClaimResult, type Client, type ClientContext, type Collection, type Comment, CommunicationService, type CompletedPart, ComplianceService, type CompressionConfig, type ConnectedAccount, type ConnectedAccountSubscription, type ConnectedSetupIntentResponse, type ConnectedSubscriptionListParams, type ConnectionStatus, type ContentFlag, type Conversation, type CostReportDay, type CreateFlagRequest, type CreateRuleRequest, type CreateSegmentRequest, type CreateSessionResponse, type CreateVariantRequest, type Credential, type CredentialScope, type Customer, type DataAccessPolicy, type DataExport, DataService, type DataSource, type DeadLetterJob, type DeviceInfo, type Document, type ErrorCode, ErrorCodes, type EventAggregation, EventsService, type FileInfo, type FlagAuditEntry, type FlagCheck, type FlagCondition, FlagContentService, type FlagDefinition, type FlagDetail, type FlagEnvironment, type FlagEvaluation, type FlagSegment, type FlagVariant, FlagsService, type FollowStatus, type FunctionExecution, type FunctionMetrics, FunctionsService, type Funnel, type FunnelConversion, type GdprRequest, type GrantInfo, type GraphEdge, type GraphNode, GraphService, IdentityService, type IdentityType, type IncomingRequestLike, type Invoice, type JobExecution, type JobStats, type Leaderboard, type LeaderboardEntry, LeaderboardService, type Like, type Listing, ListingsService, type LogEntry, type LogInput, type LogQueryParams, type LogQueryResponse, type LogRecord, LoggerService, type LoginActivitySummary, type LoginDeviceInfo, type LoginHistoryEntry, type LoginRiskInfo, type MessageCallback, type MessageStatus, type MetricDataPoint, type MfaStatus, type Model, type ModelEntitlement, type ModelPricing, type ModelProvider, type UsageSummary as ModelUsageSummary, type MultipartCompleteResponse, type MultipartPartUrlsResponse, type MultipartStartResponse, type NetworkClass, type OAuthProvider, type OAuthUrl, OrchestratorService, PHOTO_BREAKPOINTS, type PaginatedResponse, type PaginationMetadata, type PaginationParams, type PartUrl, type Participant, type Payment, type PaymentListParams, type PaymentMethod, type PaymentStatusResponse, type Payout, type PayoutSchedule, type PermissionCheck, type PermissionMatrix, PermissionsService, type PhotoInfo, PhotoService, type Pipeline, type PipelineVersion, type Policy, type PresenceCallback, type PresenceEvent, type PresignedUploadResponse, type Price, type Product, type Project, type ProjectDocument, type ProjectGrant, type ProjectMember, type PushToken, type QueryFilter, type QueryOptions, type QuerySort, type QueueJob, QueueService, type ReadStatus, RealtimeService, type RedeemResult, type Refund, type RegisterAgentRequest, type RegisterAgentResponse, type RequestOptions, type ResumeSession, type Role, type RuntimeTemplate, type RuntimeTemplateVersion, ScaleMule, ScaleMuleClient, type ScaleMuleConfig, type SchedulerJob, SchedulerService, type SearchResult, SearchService, type SecurityLayers, type ServerlessFunction, type ServiceHealth, ServiceModule, type Session, type SessionArtifact, type SessionInfo, type SessionLog, type Severity, type ShortestPathResult, type SignedUrlResponse, type SocialPost, SocialService, type SocialUser, type SsoConfig, type StatusCallback, type StorageAdapter, StorageService, type StrategyResult, type SubmitResult, type Subscription, type TargetingRule, type Task, type TaskAttempt, type TaskTransition, type Team, type TeamInvitation, type TeamMember, TeamsService, type TelemetryPayload, type Tool, type ToolCapability, type ToolIntegration, type TopEvent, type TotpSetup, type Transaction, type TransactionListParams, type TransactionSummary, type TransactionSummaryParams, type Transfer, type TransformOptions, type TransformResult, type TraversalResult, type UpdateFlagRequest, type UpdateRuleRequest, type UpdateSegmentRequest, type UpdateVariantRequest, type UploadCompleteResponse, type UploadEngineConfig, type UploadOptions, type UploadPlan, UploadResumeStore, type UploadStrategy, UploadTelemetry, type UploadTelemetryConfig, type UploadTelemetryEvent, type UpsertEnvironmentRequest, type UsageRecord, type UsageSummary$1 as UsageSummary, type UserRank, type VideoInfo, VideoService, type VideoUploadOptions, type Webhook, WebhooksService, type Workflow, type WorkflowExecution, type Workspace$1 as Workspace, type WorkspaceInvitation, type WorkspaceMember, WorkspacesService, buildClientContextHeaders, calculateTotalParts, canPerform, createUploadPlan, ScaleMule as default, detectNetworkClass, extractClientContext, generateUploadSessionId, getMeasuredBandwidthMbps, getPartRange, hasMinRoleLevel, resolveStrategy, validateIP };
|
|
5244
|
+
export { type AccountBalance, AccountsService, type ActiveUsers, type ActivityItem, AgentAuthService, AgentModelsService, type AgentProfile, AgentProjectsService, type AgentResponse, type AgentSecurityPolicy, AgentSessionsService, type AgentSigningKey, type AgentToken, type AgentToolEntitlement, AgentToolsService, type Workspace as AgentWorkspace, AgentsService, type AggregateOptions, type AggregateResult, type AnalyticsEvent, AnalyticsService, type ApiError, type ApiKey, type ApiResponse, type Appeal, type Application, type Attachment, type Attendee, type AuditLog, type AuthRegisterAgentRequest, type AuthRegisterAgentResponse, AuthService, type AuthSession, type AuthUser, type BackupCodes, BillingService, type CacheEntry, CacheService, type CalendarEvent, type CatalogEntry, CatalogService, type ChatMessage, type ChatReaction, ChatService, type ClaimResult, type Client, type ClientContext, type Collection, type Comment, CommunicationService, type CompletedPart, ComplianceService, type CompressionConfig, type ConnectedAccount, type ConnectedAccountSubscription, type ConnectedSetupIntentResponse, type ConnectedSubscriptionListParams, type ConnectionStatus, type ContentFlag, type Conversation, type CostReportDay, type CreateFlagRequest, type CreateRuleRequest, type CreateSegmentRequest, type CreateSessionResponse, type CreateVariantRequest, type Credential, type CredentialScope, type Customer, type DataAccessPolicy, type DataExport, DataService, type DataSource, type DeadLetterJob, type DeviceInfo, type Document, type ErrorCode, ErrorCodes, type EventAggregation, EventsService, type FileInfo, type FlagAuditEntry, type FlagCheck, type FlagCondition, FlagContentService, type FlagDefinition, type FlagDetail, type FlagEnvironment, type FlagEvaluation, type FlagSegment, type FlagVariant, FlagsService, type FollowStatus, type FunctionExecution, type FunctionMetrics, FunctionsService, type Funnel, type FunnelConversion, type GdprRequest, type GrantInfo, type GraphEdge, type GraphNode, GraphService, IdentityService, type IdentityType, type IncomingRequestLike, type Invoice, type JobExecution, type JobStats, type Leaderboard, type LeaderboardEntry, LeaderboardService, type Like, type Listing, ListingsService, type LogEntry, type LogInput, type LogQueryParams, type LogQueryResponse, type LogRecord, LoggerService, type LoginActivitySummary, type LoginDeviceInfo, type LoginHistoryEntry, type LoginRiskInfo, type MessageCallback, type MessageStatus, type MetricDataPoint, type MfaStatus, type Model, type ModelEntitlement, type ModelPricing, type ModelProvider, type UsageSummary as ModelUsageSummary, type MultipartCompleteResponse, type MultipartConfig, type MultipartPartUrl, type MultipartPartUrlsResponse, type MultipartStartResponse, type NetworkClass, type OAuthProvider, type OAuthUrl, OrchestratorService, PHOTO_BREAKPOINTS, type PaginatedResponse, type PaginationMetadata, type PaginationParams, type PartResult, type PartUrl, type Participant, type Payment, type PaymentListParams, type PaymentMethod, type PaymentStatusResponse, type Payout, type PayoutSchedule, type PermissionCheck, type PermissionMatrix, PermissionsService, type PhotoInfo, PhotoService, type Pipeline, type PipelineVersion, type Policy, type PresenceCallback, type PresenceEvent, type PresignedUploadResponse, type Price, type Product, type Project, type ProjectDocument, type ProjectGrant, type ProjectMember, type PushToken, type QueryFilter, type QueryOptions, type QuerySort, type QueueJob, QueueService, type ReadStatus, RealtimeService, type RedeemResult, type Refund, type RegisterAgentRequest, type RegisterAgentResponse, type RequestOptions, type ResumeSession, type Role, type RuntimeTemplate, type RuntimeTemplateVersion, type S3MultipartOptions, type S3MultipartResult, type S3SingleUploadOptions, type S3SingleUploadResult, type S3UploadProgress, ScaleMule, ScaleMuleClient, type ScaleMuleConfig, type SchedulerJob, SchedulerService, type SearchResult, SearchService, type SecurityLayers, type ServerlessFunction, type ServiceHealth, ServiceModule, type Session, type SessionArtifact, type SessionInfo, type SessionLog, type Severity, type ShortestPathResult, type SignedUrlResponse, type SocialPost, SocialService, type SocialUser, type SsoConfig, type StatusCallback, type StorageAdapter, StorageService, type StrategyResult, type SubmitResult, type Subscription, type TargetingRule, type Task, type TaskAttempt, type TaskTransition, type Team, type TeamInvitation, type TeamMember, TeamsService, type TelemetryPayload, type Tool, type ToolCapability, type ToolIntegration, type TopEvent, type TotpSetup, type Transaction, type TransactionListParams, type TransactionSummary, type TransactionSummaryParams, type Transfer, type TransformOptions, type TransformResult, type TraversalResult, type UpdateFlagRequest, type UpdateRuleRequest, type UpdateSegmentRequest, type UpdateVariantRequest, type UploadCompleteResponse, type UploadEngineConfig, type UploadFailureReport, type UploadFailureReportResponse, type UploadOptions, type UploadPlan, UploadResumeStore, type UploadStrategy, UploadTelemetry, type UploadTelemetryConfig, type UploadTelemetryEvent, type UpsertEnvironmentRequest, type UsageRecord, type UsageSummary$1 as UsageSummary, type UserRank, type VideoInfo, VideoService, type VideoUploadOptions, type Webhook, WebhooksService, type Workflow, type WorkflowExecution, type Workspace$1 as Workspace, type WorkspaceInvitation, type WorkspaceMember, WorkspacesService, buildClientContextHeaders, calculateTotalParts, canPerform, createUploadPlan, ScaleMule as default, detectNetworkClass, extractClientContext, generateUploadSessionId, getMeasuredBandwidthMbps, getPartRange, hasMinRoleLevel, resolveStrategy, uploadMultipartToS3, uploadSingleToS3, validateIP };
|