@docstack/client 0.1.8 → 0.2.0

package/lib/core/transaction-engine/sweep.d.ts

@@ -0,0 +1,26 @@
+import Class from "../class.js";
+import type ClientStack from "../stack.js";
+import { TransactionStage, StagedEntry } from "./stage.js";
+/**
+ * Resolves a class from the transaction's own stage: the ADR-0043 rule
+ * (the batch outranks the store - it is what is about to be committed) applied to
+ * staging. A patch chain's job can create documents of a class an earlier patch
+ * staged (ADR-0044), and the sweep must judge them by that staged model, not by a
+ * committed predecessor or a not-found. Built DETACHED - `Class.get` + `setModel`,
+ * never `buildFromModel`, which writes rev-less models (ADR-0043).
+ */
+export declare const classFromStage: (stack: ClientStack, stage: TransactionStage, className: string) => Class | null;
+/**
+ * The validation sweep - the transaction's atomicity boundary in practice.
+ *
+ * Runs read-only checks against public stack APIs: it decides whether a document
+ * *could* be written, and touches nothing. Stage time runs it so a bad write fails at
+ * the call site with zero consequences; commit re-runs it so the batch is judged
+ * against the world as it stands at commit. The commit-time pipeline (the plugin's
+ * `bulkDocs`) remains the sole authority - this sweep is a deliberate subset, and a
+ * document it passes can still be refused there, atomically for the whole batch.
+ */
+export declare const sweepEntry: (stack: ClientStack, stage: TransactionStage, entry: StagedEntry, options?: {
+    allowClassModels?: boolean;
+    skipPolicy?: boolean;
+}) => Promise<void>;

package/lib/index.d.ts

@@ -18,9 +18,19 @@ export type { SchedulerOptions, SchedulerHost, JobScheduleState, TickReport, Ski
  * application hands over, so DocStack never learns about Google Drive, Firestore or
  * anything else, and no consumer pays for a transport it does not use.
  */
-export { StackSyncHandle, DocStackSyncHandle, SyncSchemaMismatchError, SYNC_META_DOC_ID, readRemoteSchemaVersion, publishSchemaVersion, createReplicationFilter, isInternalDoc, resolveInternalClasses, createClassFilter, hasClassRules, DATA_MODEL_CLASSES, withFilterIdentity, describeFilter, INTERNAL_DOC_IDS, INTERNAL_DOC_ID_PREFIXES, INTERNAL_DOC_CLASSES, OPTIONAL_INTERNAL_DOC_CLASSES, StackWriteGuardError, StackLockedError, deriveKeyId, isEncryptedPayload, deriveTenantScope, classTenants, } from "./core/index.js";
+export { StackSyncHandle, DocStackSyncHandle, SyncSchemaMismatchError, SYNC_META_DOC_ID, readRemoteSchemaVersion, readRemoteConsumerSchemaVersion, publishSchemaVersion, createReplicationFilter, isInternalDoc, resolveInternalClasses, createClassFilter, hasClassRules, DATA_MODEL_CLASSES, withFilterIdentity, describeFilter, INTERNAL_DOC_IDS, INTERNAL_DOC_ID_PREFIXES, INTERNAL_DOC_CLASSES, OPTIONAL_INTERNAL_DOC_CLASSES, StackWriteGuardError, StackLockedError, deriveKeyId, isEncryptedPayload, deriveTenantScope, classTenants, } from "./core/index.js";
 export { SYSTEM_SEEDED_DOC_IDS, collectQueryClasses } from "./core/index.js";
 export type { EncryptedPayload, ClassBuildOptions } from "./core/index.js";
+/**
+ * Named write transactions (ADR-0039).
+ *
+ * Opt-in per stack via `transactions: true`. A handle stages validated writes in
+ * memory and reads its own staged state overlaid on committed state; `commit`
+ * flushes the journal as one batch through the full authoring pipeline, and the
+ * report states the storage adapter's honest atomicity guarantee.
+ */
+export { TransactionEngine, TransactionHandle, TransactionDb, TransactionsDisabledError, TransactionStateError, TransactionValidationError, TransactionConflictError, TransactionUnsupportedDocError, } from "./core/index.js";
+export type { TransactionCommitReport, TransactionStatus } from "./core/index.js";
 /**
  * Moving application content between stacks, without the datamodel that describes it.
  */
@@ -37,5 +47,5 @@ export type { SyncDirection, SyncState, SyncStatus, StackSyncOptions, DocStackSy
  * Note that `Document` shadows the DOM's global `Document` in whichever module imports
  * it; alias it (`import type { Document as DocStackDocument }`) in code that needs both.
  */
-export type { AttributeType, AttributeTypeConfig, AttributeModel, ClassModel, DomainModel, TriggerModel, Document, RelationDocument, Patch, SelectAST, UnionAST, ClientCredentials, DocstackReady, StackConfig, StackOptions, } from "@docstack/shared";
+export type { AttributeType, AttributeTypeConfig, AttributeModel, ClassModel, DomainModel, TriggerModel, Document, RelationDocument, Patch, PatchJob, SelectAST, UnionAST, ClientCredentials, DocstackReady, StackConfig, StackOptions, } from "@docstack/shared";
 export default DocStack;