@cloudbitmaps/roaring 0.19.1 → 0.20.0

package/dist/open-charging-storage.d.ts

@@ -13,7 +13,7 @@
  * which it reads back to verify. A refusal here comes from a read, and in an erasure the reads that can be refused
  * come before the deletes.
  */
-import type { GenKey, IStorageDriver, SegmentRef } from '@cloudbitmaps/core';
+import type { GenKey, IStorageDriver, SegmentRef, StorageDeleteOptions } from '@cloudbitmaps/core';
 export declare class OpenChargingStorage implements IStorageDriver {
     private readonly inner;
     private readonly charge;
@@ -29,6 +29,7 @@ export declare class OpenChargingStorage implements IStorageDriver {
     getRange(key: GenKey, offset: number, length: number): Promise<Uint8Array>;
     /** One `getTail` is one open: a reader takes the footer and the index from it, and reads chunks with `getRange`. */
     getTail(key: GenKey, maxBytes: number): ReturnType<IStorageDriver['getTail']>;
-    delete(key: GenKey): Promise<void>;
+    /** Handed through whole: the erasure's delete of a holder is conditioned on the object it searched. */
+    delete(key: GenKey, options?: StorageDeleteOptions): Promise<void>;
     list(ref: SegmentRef): AsyncIterable<GenKey>;
 }

package/dist/testing/conformance.d.ts

@@ -15,13 +15,13 @@ export declare function storageChunkSourceConformance(label: string, makeSource:
     bitmap: SafeBitmap;
 }>) => Promise<StorageChunkSource>): void;
 /** The storage-driver cases {@link storageDriverConformance} runs; an emulator that cannot model one skips it by name. */
-export type StorageDriverCase = 'write-once round trip' | 'collision' | 'collision on a large upload' | 'missing object' | 'out-of-range read' | 'tail size' | 'idempotent delete' | 'delete of an absent key beside its neighbours' | 'list read-after-delete' | 'names and namespaces kept apart' | 'generations by number' | 'failed write' | 'missing location' | 'list across pages';
+export type StorageDriverCase = 'write-once round trip' | 'collision' | 'collision on a large upload' | 'missing object' | 'out-of-range read' | 'tail size' | 'idempotent delete' | 'delete of an absent key beside its neighbours' | 'list read-after-delete' | 'names and namespaces kept apart' | 'generations by number' | 'failed write' | 'missing location' | 'list across pages' | 'conditional delete';
 /**
  * Contract tests for an {@link IStorageDriver} — the contract its doc comment lists: write-once with
  * `WriteConflictError` on a collision, `NotFoundError` for a missing object, `ValidationError` for an out-of-range
- * read, `getTail`'s true total size, idempotent `delete` (of an absent key too, with neighbours present), and a `list`
- * that is read-after-delete. `makeDriver` MUST
- * return a driver over an empty, isolated keyspace on each call.
+ * read, `getTail`'s true total size, idempotent `delete` (of an absent key too, with neighbours present), a `list`
+ * that is read-after-delete, and a `delete` given `ifVersion` that does what `conditionalDelete` says. `makeDriver`
+ * MUST return a driver over an empty, isolated keyspace on each call.
  *
  * `skip` names the cases a backend cannot exercise (a local emulator that does not model a contract), so each
  * skip is visible at the call site, with the reason beside it, rather than hidden in a weakened assertion.
@@ -47,6 +47,13 @@ export declare function storageDriverConformance(label: string, makeDriver: () =
      * driver that drops its continuation token fails. Omitted, the case does not run.
      */
     readonly pagedListSize?: number;
+    /**
+     * What the driver under test reports as `capabilities().conditionalDelete` once it has made a delete given
+     * `ifVersion`, which is when a driver that resolves it lazily has resolved it. Stated at the call site, so a driver
+     * that stops applying the condition fails here rather than being exempted by its own report. Omitted, the case
+     * holds the driver to whatever it reports.
+     */
+    readonly conditionalDelete?: boolean;
 }): void;
 /**
  * Contract tests for an {@link IRegistryDriver}. `makeDriver` MUST return a fresh, empty, isolated driver on
@@ -92,8 +99,8 @@ export interface RegistryDeleteHarness {
     /** Whether the backend holds anything for `ref`: a live row, or the tombstone a delete left in its place. */
     stored(ref: SegmentRef): Promise<boolean>;
     /**
-     * Put `text` at `ref`'s row, as another writer left it: here, a row as a release before 0.12 wrote it. Omitted by
-     * a registry that persists nothing a test can plant (the in-memory one).
+     * Put `text` at `ref`'s row, as another writer left it: here, a row stamped with an earlier schema. Omitted by a
+     * registry that persists nothing a test can plant (the in-memory one).
      */
     plantRow?(ref: SegmentRef, text: string): Promise<void>;
 }
@@ -101,10 +108,8 @@ export interface RegistryDeleteHarness {
  * Contract tests for what `delete` leaves behind, which differs by driver and is declared by
  * `capabilities().conditionalDelete`:
  *
- * - **`true`**: a delete removes a row whose token carries an incarnation id from the backend for good, and does so
- *   only while the row is still the version it read. A row a release before 0.12 wrote has a bare decimal token and
- *   is tombstoned, never removed: a process still on that release, re-creating the name over nothing, would issue
- *   those same counters again from 0.
+ * - **`true`**: a delete removes the row from the backend for good, and does so only while the row is still the
+ *   version it read.
  * - **`false` or absent**: every delete leaves a tombstone, which a later full listing still reads.
  *
  * Either way `get` answers `null` afterwards, `list` skips the row, and a name created again is a new incarnation that

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudbitmaps/roaring",
-  "version": "0.19.1",
+  "version": "0.20.0",
   "description": "Distributed, cloud-native Roaring Bitmaps — query and intersect billion-scale integer sets straight out of object storage, from a bounded RAM cache over immutable objects in your own bucket, at a fraction of an always-on cache.",
   "keywords": [
     "roaring",
@@ -65,7 +65,7 @@
   },
   "dependencies": {
     "roaring": "2.7.0",
-    "@cloudbitmaps/core": "^0.19.1"
+    "@cloudbitmaps/core": "^0.20.0"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",