@syncular/server 0.34.0 → 0.36.0

package/src/storage-errors.ts

@@ -34,7 +34,9 @@ export type StorageQueryErrorCode =
   | 'sync.storage.stored_layout_mismatch'
   | 'sync.storage.physical_layout_mismatch'
   | 'sync.storage.transaction_query_unsupported'
-  | 'sync.storage.query_over_staged_writes';
+  | 'sync.storage.query_over_staged_writes'
+  | 'sync.storage.erase_unsupported'
+  | 'sync.storage.invalid_erase_query';
 
 const STORAGE_QUERY_MESSAGES: Readonly<Record<StorageQueryErrorCode, string>> =
   {
@@ -78,6 +80,10 @@ const STORAGE_QUERY_MESSAGES: Readonly<Record<StorageQueryErrorCode, string>> =
       'trusted row lookup requires one exact value per index column',
     'sync.storage.invalid_limit':
       'trusted row lookup limit must be an integer from 1 through 1,000',
+    'sync.storage.erase_unsupported':
+      'this storage backend cannot erase a scope value',
+    'sync.storage.invalid_erase_query':
+      'erasure requires a declared scope variable, a non-empty value, and a row budget within the operation cap',
   };
 
 /**

package/src/storage.ts

@@ -957,6 +957,29 @@ export interface ServerStorage {
   ): Promise<BlobReferencingRow[]>;
   listReferencedBlobIds?(partition: string): Promise<string[]>;
 
+  /**
+   * §4.6.1 scope-value erasure — ADDITIVE, optional; `eraseScopeValue`
+   * requires both.
+   *
+   * `listScopeValueRows`: up to `limit` rowIds of `table` whose stored scope
+   * binds `variable` to `value`, ordered by rowId (the row scope index).
+   *
+   * `eraseScopeValueHistory`: under the partition write lock, removes up to
+   * `limit` upsert change records of `table` at or below `throughSeq` whose
+   * scopes bind `variable` to `value`, then up to `limit` change scope index
+   * entries of that binding whose commit holds no such change any more.
+   * Delete change records stay: clients behind the erasure still need them.
+   * Returns the number of records removed.
+   */
+  listScopeValueRows?(
+    partition: string,
+    query: ScopeValueQuery,
+  ): Promise<string[]>;
+  eraseScopeValueHistory?(
+    partition: string,
+    query: ScopeValueHistoryQuery,
+  ): Promise<number>;
+
   /**
    * Admin/console read surface (`SyncularAdmin`): ADDITIVE,
    * optional. All read-only, partition-scoped, and JSON-able. A backend
@@ -1008,6 +1031,18 @@ export interface ServerStorage {
   listPartitions(): Promise<string[]>;
 }
 
+/** One scope binding of one table, budgeted (§4.6.1). */
+export interface ScopeValueQuery {
+  readonly table: string;
+  readonly variable: string;
+  readonly value: string;
+  readonly limit: number;
+}
+
+export interface ScopeValueHistoryQuery extends ScopeValueQuery {
+  readonly throughSeq: number;
+}
+
 /** A row referencing a blob, with the scopes needed to authorize download. */
 export interface BlobReferencingRow {
   readonly table: string;