@cloudbitmaps/core 0.21.0 → 0.23.0

package/dist/index.d.ts

@@ -1,16 +1,19 @@
 /**
  * `@cloudbitmaps/core` — the codec-agnostic cloud engine behind the @cloudbitmaps family.
  *
- * Everything here is **independent of any bitmap codec**: the read engine, the SDK-free storage backends, the `.crbm`
+ * Everything here is **independent of any bitmap codec**: the read engine, the `.crbm`
  * format, the loaded store's write path (`loadSegment`: write, guard, publish, collect), encryption/crypto-shred, the registry,
  * the budget/consistency/eject machinery. Bitmaps are only ever constructed and combined through the
  * {@link CodecInterface} seam, so a *flavor* package (`@cloudbitmaps/roaring` today) supplies the codec and a
  * facade on top.
  *
- * **You normally install a flavor, not this package** — `pnpm add @cloudbitmaps/roaring` pulls this in
- * transitively and re-exports, by name, what an application uses, so `@cloudbitmaps/roaring` is the one name to
- * know. The engine, the standalone forms of the store's methods and the retry and budget internals stay here:
- * depend on `core` directly only when authoring a new flavor or a driver.
+ * **This entry is internal.** It is the engine `@cloudbitmaps/roaring` and the storage-driver packages import, and it is
+ * outside the stability promise: it can change in any release, and a change to it gets no CHANGELOG Breaking
+ * entry. Install `@cloudbitmaps/roaring` and a driver; `@cloudbitmaps/roaring` re-exports, by name, what an application
+ * uses. The public entry of this package is `@cloudbitmaps/core/driver-kit`, the contract for writing a driver.
+ *
+ * The drivers that need a Node builtin (the in-memory and local-filesystem backends, the in-process cipher and
+ * keystore) are exported by `@cloudbitmaps/core/node`, so nothing this entry reaches imports a `node:*` builtin.
  *
  * Nothing in here may import a flavor package — the dependency arrow is one-way (flavor → core), so core stays
  * publishable on its own and every codec reuses one driver set with zero duplication.
@@ -25,12 +28,10 @@ export { splitId } from './core/bit-route.js';
 export { mapWithConcurrency } from './core/concurrency.js';
 export { resolveBudget, resolvePerOpBudget, checkBudget, collectWithinBudget } from './core/budget.js';
 export { segmentExists, listSegments } from './core/discover.js';
+export { refuseUnknownRefKeys } from './core/validate.js';
 export type { SegmentInfo } from './core/discover.js';
-export type { Token } from './core/ports.js';
 export { segmentKey } from './core/keys.js';
 export { isStorageBackend } from './core/ports.js';
-export { LocalFsStorage, MemoryStorage } from './drivers/backends.js';
-export type { LocalFsStorageOptions, MemoryStorageOptions } from './drivers/backends.js';
 export { CrbmStorageChunkSource } from './core/crbm-storage-source.js';
 export type { CrbmStorageChunkSourceOptions, PinLease, PinnedObject, } from './core/crbm-storage-source.js';
 export { LEASE_SKEW_MS, MAX_LEASE_MS, MAX_LEASES_PER_SEGMENT, releaseLease, takeLease, } from './core/leases.js';
@@ -39,31 +40,32 @@ export { PinnedStorageChunkSource } from './core/pinned-storage-source.js';
 export type { PinnedAt } from './core/pinned-storage-source.js';
 export { judgeLoad, loadSegment, loadSegmentChunks } from './core/load.js';
 export { compileCombineMany, rebindCombineMany, runCombineMany } from './core/combine-many.js';
-export type { CombineExpr, CombineManyDeps, CombineManyFeed, CombineManyFeedRecord, CombineManyOperand, CombineManyOperandStats, CombineManyOutcome, CombineManyOutput, CombineManyOutputStats, CombineManyRequest, CombineManyRun, CombineManyStats, CombineManyWrite, CompiledCombineMany, } from './core/combine-many.js';
+export type { CombineManyDeps, CombineManyFeed, CombineManyOperand, CombineManyOutcome, CombineManyOutput, CombineManyRequest, CombineManyRun, CombineManyWrite, CompiledCombineMany, Expr, MaterializeManyFeedRecord, MaterializeManyOperandStats, MaterializeManyOutputStats, MaterializeManyStats, } from './core/combine-many.js';
 export type { LoadDeps, LoadOptions, LoadGuard, GuardRefusal, LoadJudgement, LoadResult, LoadRefusal, } from './core/load.js';
 export type { LoadInput, PortableBitmap } from './core/load-input.js';
 export { decodeSerialized } from './core/load-input.js';
 export { listGenerations, rollbackSegment } from './core/rollback.js';
 export type { GenerationListDeps, GenerationEntry, RollbackResult } from './core/rollback.js';
-export { eraseIdFromSegment } from './core/erase-id.js';
-export type { EraseIdDeps, EraseIdResult } from './core/erase-id.js';
+export { eraseIdFromSegment, findIdUnderTombstone } from './core/erase-id.js';
+export type { EraseIdDeps, EraseIdResult, SearchDeps } from './core/erase-id.js';
 export type { CodecInterface, CodecBitmap, EncodedChunk } from './core/codec.js';
 export type { Clock, Entropy, Rng } from './core/determinism.js';
-export type { StorageChunkSource, IStorageDriver, StorageCaps, StorageDeleteOptions, TailRead, ChunkRef, ChunkRead, ReadChunksOptions, SegmentRef, GenKey, IRegistryDriver, StorageBackend, RegistryRecord, NewRegistryRecord, RegistryPatch, RegistryStatus, RegistrySummary, RegistryWriteOptions, LeaseEntry, KnownGeneration, ClearRegistrySummary, SealedRegistrySummary, GenerationMetadata, GenerationSummary, RegCaps, GovernanceMeta, SegmentSize, } from './core/ports.js';
-export { CloudRoaringError, ValidationError, WriteConflictError, IntegrityError, NotFoundError, UnsupportedError, CapabilityError, TransientError, KeyUnavailableError, BudgetExceededError, LeaseExpiredError, LeaseLimitError, StaleOperandError, isCloudRoaringError, isWriteConflictError, isTransientError, isNotFoundError, isIntegrityError, isValidationError, isLeaseExpiredError, isLeaseLimitError, isStaleOperandError, isUnsupportedError, isCapabilityError, isBudgetExceededError, isKeyUnavailableError, } from './core/errors.js';
-export type { Aead, AeadSealed, IKeystore, WrappedDek, CrbmCrypto } from './core/crypto.js';
+export type { SegmentRef, GenerationMetadata } from './core/ports.js';
+export { CloudRoaringError, ValidationError, WriteConflictError, IntegrityError, NotFoundError, UnsupportedError, CapabilityError, TransientError, KeyUnavailableError, BudgetExceededError, LeaseExpiredError, LeaseLimitError, StaleOperandError, errorKind, } from './core/errors.js';
+export type { CrbmCrypto } from './core/crypto.js';
 export { aadFor } from './core/crypto.js';
-export { NodeAead, InProcessKeystore } from './drivers/crypto.js';
-export type { InProcessKeystoreOptions } from './drivers/crypto.js';
 export { destroySegment, dropSegment, eraseNamespace } from './core/erasure.js';
 export type { DropDeps, DropResult, EraseDeps, DestroyResult } from './core/erasure.js';
 export { setSegmentRetention, clearSegmentRetention, getSegmentRetention, readRetentionPolicy, MIN_EXPIRES_AT_MS, } from './core/retention.js';
 export type { RetentionPolicy, RetentionDeps, SetRetentionResult } from './core/retention.js';
 export { retireExpired } from './core/retention-sweep.js';
+export { runPreflight } from './core/preflight.js';
+export type { PreflightCheck, PreflightDeps, PreflightResult } from './core/preflight.js';
 export { excludingReservedRows } from './core/registry-scan.js';
 export type { RetireExpiredOptions, RetireExpiredResult, RetireEntry, } from './core/retention-sweep.js';
 export { DEFAULT_BUDGET } from './core/budget.js';
 export type { Budget, BudgetOption } from './core/budget.js';
+export type { ErrorKind } from './core/errors.js';
 export { runConsistencyCheck } from './core/consistency.js';
 export type { ConsistencyReport, ConsistencyIssue, ConsistencyErrorEntry, } from './core/consistency.js';
 export type { ExportFormat, ExportSink, ExportWriter, ExportOptions, ExportedSegment, ExportFailure, ExportManifest, ExportSkipped, } from './export/index.js';
@@ -74,7 +76,7 @@ export type { RetryingOptions } from './drivers/retry/retrying-chunk-source.js';
 export { CrbmReader } from './core/crbm/reader.js';
 export type { CrbmReaderOptions } from './core/crbm/reader.js';
 export { BufferReader } from './core/blob.js';
-export type { BlobReader, BlobSink } from './core/blob.js';
+export type { BlobReader } from './core/blob.js';
 export { NOOP_METRICS, CountingMetricsSink } from './core/metrics.js';
 export type { IMetricsSink, MetricEvent, MetricOpName, MetricsSnapshot } from './core/metrics.js';
 export { RecordingAuditSink } from './core/audit.js';