@qaecy/cue-sdk 0.0.41 → 0.0.44

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/README.md CHANGED
@@ -404,6 +404,29 @@ Returns a `SyncResult`:
404
404
  | `totalSize` | `number` | Total size across all files |
405
405
  | `rdfWritten` | `boolean` | Whether any RDF metadata was written |
406
406
 
407
+ ### Gzip-on-upload (per-project rollout)
408
+
409
+ `CueBlobStorage.uploadRaw` can gzip-compress a raw file before upload — set
410
+ GCS's native `contentEncoding: 'gzip'` (so every read path transparently
411
+ decompresses it) and mark `content_encoding: 'gzip'` in the file's custom
412
+ metadata (so it's identifiable without downloading the object; absent means
413
+ the stored bytes are the original, uncompressed file). Only suffixes that
414
+ actually compress well are eligible (`.ifc`, `.dxf`, `.ttl`, `.nt`, `.jelly`,
415
+ `.json`, `.txt`) — see `plan.md` design decision 3 for the numbers behind
416
+ that list.
417
+
418
+ Whether a given upload gets compressed is gated per-project by
419
+ `ProjectSettings.gzipEnabled` (absent/false = uncompressed, the default for
420
+ every project today). `sync()` and `syncBrowserFile()` read this from the
421
+ project doc and forward it to `uploadRaw`'s trailing `gzip` param —
422
+ `syncBrowserFile` caches it once per space (populated by `initBrowserSync`)
423
+ rather than re-fetching the project on every dropped file. There is no
424
+ admin-panel toggle for this yet (same as `tier` on an already-created
425
+ project) — enable it for a project by setting `projectSettings.gzipEnabled:
426
+ true` directly on that project's Firestore doc. See `gzip-steps.md` Phase 3
427
+ for the rollout sequencing (one test project first, verify end-to-end, then
428
+ expand).
429
+
407
430
  ## GIS
408
431
 
409
432
  Reactive GIS service for querying spatial features within a map viewport. Accessed via the lazy getter `cue.gis` — the `CueGis` instance is created on first access and reused for the lifetime of the `Cue` object.