@cloudbitmaps/roaring 0.24.0 → 0.26.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudbitmaps/roaring",
-  "version": "0.24.0",
+  "version": "0.26.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",
@@ -64,7 +64,7 @@
     "export-segments": "./dist/bin/export-segments.js"
   },
   "dependencies": {
-    "@cloudbitmaps/core": "0.24.0"
+    "@cloudbitmaps/core": "0.26.0"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",

package/dist/roaring-codec.d.ts

@@ -1,49 +0,0 @@
-/**
- * The codec selection point and the load-input and decode helpers the `CloudRoaring` facade builds on.
- *
- * The store's codec is the TypeScript Roaring codec (`ts-roaring/bitmap.ts`): the portable format, read and written in
- * JavaScript with no native addon. Every deserialize is preceded by a hard size cap and a structural check
- * (`portable/layout.ts`). The `unsafe_frozen_*` formats are never used.
- */
-import type { CodecInterface, LoadInput, PortableBitmap } from '@cloudbitmaps/core';
-/**
- * An iterable that serializes itself to portable Roaring (an object with `Symbol.iterator` and a `serialize` method: a
- * caller's `RoaringBitmap32` from the `roaring` package, another copy's bitmap, or a bitmap {@link deserializePortable}
- * returned), passed where ids go, loads as `{ bitmap }`: from its containers, through the same check as any bytes,
- * never id by id. Its `serialize` decides, even where it disagrees with what it iterates. Any other input passes
- * through unchanged, so the core's own rules apply to it: a byte array (`Uint8Array`, `Buffer`) is refused as ids even
- * with a `serialize` of its own, and an object that is not iterable is read as `{ serialized }` or `{ bitmap }` or
- * refused, whatever else it has.
- */
-export declare function bitmapAsLoadInput(input: LoadInput): LoadInput;
-/**
- * The codec the store hands to the engine at every site that injects one (`CloudRoaring`, a load, a pin, an export
- * and {@link deserializePortable}): the TypeScript codec unless a harness has flipped it with {@link setFlagshipCodec}.
- * Internal: no public entry exports it, and a store cannot be configured with a codec.
- */
-export declare function flagshipCodec(): CodecInterface;
-/** Flip the codec the store uses, for the whole process. Test and bench harnesses only; returns the previous one. */
-export declare function setFlagshipCodec(codec: CodecInterface): CodecInterface;
-/**
- * A decoded bitmap that can only be read: what {@link deserializePortable} returns. Its ids come out ascending when
- * it is iterated, which is a promise. It is a `PortableBitmap`, so a load takes it as `{ bitmap }`, and the library
- * keeps no reference to it. What {@link deserializePortable} returns has these members only: a call to any other
- * throws `TypeError`, it has no `getSerializationSizeInBytes`, and `serialize` takes exactly `'portable'`. Its class
- * is not part of the contract: do not cast it and do not test it with `instanceof`. Passed to a method of the `roaring`
- * package from npm in place of a `RoaringBitmap32`, it answers wrongly: decode its bytes first. `JSON.stringify` of one gives `"{}"`; write
- * `JSON.stringify([...bitmap])`. For the rest of a Roaring library's API, decode its portable bytes with that library.
- */
-export interface ReadonlyBitmap extends PortableBitmap, Iterable<number> {
-    /** How many ids it holds. */
-    readonly size: number;
-    /** Whether it holds `id`. */
-    has(id: number): boolean;
-}
-/**
- * Decode portable Roaring bytes you hold into a {@link ReadonlyBitmap}, through the check a `{ serialized }` load
- * makes first: a size cap, a structural check, one whole bitmap, and only then the decoder.
- *
- * @param bytes a `Uint8Array`, which a Node `Buffer` is.
- * @throws {ValidationError} for bytes that are not exactly one well-formed portable bitmap, as a load refuses them.
- */
-export declare function deserializePortable(bytes: Uint8Array): ReadonlyBitmap;