@cloudbitmaps/core 0.20.0 → 0.21.0

package/dist/drivers/localfs/storage.d.ts

@@ -1,9 +1,16 @@
-import type { BlobSink } from '../../core/blob.js';
+import { type BlobSink } from '../../core/blob.js';
 import type { StorageCaps, GenKey, IStorageDriver, SegmentRef, StorageDeleteOptions, TailRead } from '../../core/ports.js';
 export declare class LocalFsStorageDriver implements IStorageDriver {
     private readonly root;
+    private readonly options;
     private readonly exactCase;
-    constructor(root: string);
+    /**
+     * `options.privateRoot` is the directory this one lives under, from which down directories are created private; it
+     * defaults to `root`.
+     */
+    constructor(root: string, options?: {
+        readonly privateRoot?: string;
+    });
     capabilities(): StorageCaps;
     putImmutable(key: GenKey, write: (sink: BlobSink) => Promise<void>): Promise<{
         size: number;

package/dist/drivers/memory.d.ts

@@ -1,7 +1,7 @@
 import type { BlobSink } from '../core/blob.js';
 import type { Entropy } from '../core/determinism.js';
-import type { StorageCaps, StorageDeleteOptions, TailRead, GenKey, IStorageDriver, IRegistryDriver, NewRegistryRecord, RegCaps, RegistryPatch, RegistryRecord, SegmentRef, Token } from '../core/ports.js';
-export interface MemoryRegistryDriverOptions {
+import type { StorageCaps, StorageDeleteOptions, TailRead, GenKey, IStorageDriver, IRegistryDriver, NewRegistryRecord, RegCaps, RegistryPatch, RegistryRecord, RegistryWriteOptions, SegmentRef, Token } from '../core/ports.js';
+interface MemoryRegistryDriverOptions {
     /** Injected clock for `createdAt`/`updatedAt`; defaults to `Date.now` (drivers may use ambient time). */
     readonly now?: () => number;
     /** Draws every token's random parts; defaults to Web Crypto. Inject one only to make a test replayable. */
@@ -22,15 +22,17 @@ export declare class MemoryRegistryDriver implements IRegistryDriver {
     private nextToken;
     /** `conditionalDelete`: a delete checks the token and removes the row in one step, with no await between. */
     capabilities(): RegCaps;
+    /** Every write reports its token to `onToken` before it is applied. */
+    get reportsWriteTokens(): true;
     get(ref: SegmentRef): Promise<RegistryRecord | null>;
-    create(ref: SegmentRef, record: NewRegistryRecord): Promise<{
+    create(ref: SegmentRef, record: NewRegistryRecord, options?: RegistryWriteOptions): Promise<{
         token: Token;
     }>;
     /**
      * A caller's `held` row (see `RegistryWriteOptions`) has no read to spare here: the token is compared with the stored row in the same step
      * as the write, in memory, so a stale one fails exactly as a lost race does.
      */
-    compareAndSwap(ref: SegmentRef, expected: Token, patch: RegistryPatch): Promise<{
+    compareAndSwap(ref: SegmentRef, expected: Token, patch: RegistryPatch, options?: RegistryWriteOptions): Promise<{
         token: Token;
     }>;
     list(namespace?: string): AsyncIterable<RegistryRecord>;
@@ -59,3 +61,4 @@ export declare class MemoryStorageDriver implements IStorageDriver {
     list(ref: SegmentRef): AsyncIterable<GenKey>;
     private require;
 }
+export {};

package/dist/index.d.ts

@@ -49,7 +49,7 @@ export { eraseIdFromSegment } from './core/erase-id.js';
 export type { EraseIdDeps, EraseIdResult } 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, ClearRegistrySummary, SealedRegistrySummary, GenerationMetadata, GenerationSummary, RegCaps, GovernanceMeta, SegmentSize, } from './core/ports.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 { aadFor } from './core/crypto.js';