@microdelta/history 0.0.0 → 0.2.0

package/dist/api/history.untrimmed.d.ts

@@ -0,0 +1,3 @@
+/** Entry-specific exports preserve one History type identity per release tier. */
+export { AttemptConflictError, AttemptStateError, DuplicateRowError, FingerprintAlgorithmMismatchError, HistoryClockError, HistoryIntegrityError, HistorySchemaError, InvalidStorePatchError, JournalConflictError, JournalVersionError, MissingRowError, StaleWriterError, createMemoryStore, openDurableHistory } from './history.shared.untrimmed.js';
+export type { Divergence, FieldRow, Fingerprint, GenerationPatch, GenerationRow, GenerationState, IAbandonRequest, IAcceptanceRecord, IAcceptanceRequest, IAddressSegment, IAttemptRecord, IAttemptRequest, IAttemptState, IClockCapability, ICompletedEnvelope, ICompletedNavigationReader, ICompletedProjectionReader, ICompletedResultReader, ICompletedResultReference, IDurableHistory, IDurableHistoryOptions, IHistoryScope, IJournalAddress, IJournalCommit, IJournalDeclaration, IJournalFormat, IJournalQuery, IJournalRecord, IJournalWrite, IOperation, IOperationJournal, IPromotionQuery, IPromotionRecord, IPromotionRequest, IRecoveryOutcome, IResultVerification, IScopedSubject, ISelectedFact, ISelectedFingerprintRequest, ISelectedFingerprintResolution, ISelectedNode, ISelectedReadRequest, ISha256Capability, ISqliteCapability, ISqliteConnection, ISqliteRow, ISqliteRunResult, ISqliteStatement, ISqliteSynchronousResult, ISqliteValue, IStageRequest, IValueProjectionDescriptor, IValueProjectionFact, IValueProjectionMember, IValueProjectionTraversal, IVersionedRecord, IVersionedSubject, IWriterAcquisition, IWriterAcquisitionRequest, IWriterContention, IWriterLease, IWriterRenewal, Identity, MemoryStoreOptions, Outcome, Path, RecordedRead, ResultKey, Store, StoreMetadata, Subject, SubjectPatch, SubjectRow } from './history.shared.untrimmed.js';

package/dist/api/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.59.2"
+    }
+  ]
+}

package/dist/src/completed-results.d.ts

@@ -0,0 +1,99 @@
+/**
+ * Exact completed-snapshot reading contracts used by Materialization. These
+ * interfaces locate immutable results but neither implement a backend nor decide
+ * freshness, publication, authorization, or candidate eligibility.
+ * @packageDocumentation
+ */
+import type { IAddressSegment, IOperation, ISelectedFact, ISelectedNode, IValueProjectionDescriptor, IValueProjectionFact } from '@microdelta/value';
+/**
+ * A caller-visible locator for one completed immutable snapshot. The opaque
+ * locator carries whatever analysis and environment scope its reader requires;
+ * it is never a payload or a request to follow a current pointer.
+ * @alpha
+ */
+export interface ICompletedResultReference {
+    /** Dispatches resolution to the completed-result contract. */
+    readonly kind: 'completed-result';
+    /** Opaque exact snapshot locator interpreted only by its injected reader. */
+    readonly locator: string;
+}
+/** A selected Value-owned scalar fact requested at an exact retained address. @alpha */
+export interface ISelectedReadRequest {
+    /** The literal operation whose fact is requested. */
+    readonly operation: IOperation;
+    /** Container-aware path within this selected result value. */
+    readonly address: readonly IAddressSegment[];
+}
+/**
+ * Metadata lookup is scoped to the exact result reference and full requested
+ * selection. The encoding tag prevents an indexed digest from another semantic
+ * version being mistaken for this selection.
+ * @alpha
+ */
+export type ISelectedFingerprintRequest = {
+    readonly kind: 'selected';
+    readonly operation: IOperation;
+    readonly address: readonly IAddressSegment[];
+    readonly encoding: 'MDO1';
+} | {
+    readonly kind: 'projection';
+    readonly descriptor: IValueProjectionDescriptor;
+    readonly encoding: 'MDP1';
+} | {
+    readonly kind: 'materialized-output';
+    readonly address: readonly IAddressSegment[];
+    readonly encoding: 'MDS1';
+};
+/** Explicit results keep absent or incompatible metadata from implying equality. @alpha */
+export type ISelectedFingerprintResolution = {
+    readonly kind: 'compatible';
+    readonly fingerprint: string;
+} | {
+    readonly kind: 'unavailable';
+} | {
+    readonly kind: 'incompatible';
+} | {
+    readonly kind: 'ambiguous';
+};
+/**
+ * Synchronous scalar access and fingerprint-only resolution for one exact
+ * completed snapshot. A compatible fingerprint answer must be backed by the
+ * same semantics as a selected read; resolving metadata never reads payload.
+ * @alpha
+ */
+export interface ICompletedResultReader {
+    /** Read the requested fact from exactly this reference, never from current. */
+    readSelected(reference: ICompletedResultReference, request: ISelectedReadRequest): ISelectedFact;
+    /** Resolve matching metadata only; unavailable metadata does not trigger a read. */
+    resolveFingerprint(reference: ICompletedResultReference, request: ISelectedFingerprintRequest): ISelectedFingerprintResolution;
+}
+/**
+ * Optional capability for readers that can supply an exact keyed projection as
+ * selected member values. Scalar readers do not need to implement projections.
+ * @alpha
+ */
+export interface ICompletedProjectionReader {
+    /** Read only the projection's requested address and keyed selected values. */
+    readProjection(reference: ICompletedResultReference, descriptor: IValueProjectionDescriptor): IValueProjectionFact;
+}
+/**
+ * Optional capability for readers that can navigate one exact completed
+ * snapshot node by node, for lazy nested views. A navigation answer is the
+ * scalar value fact or the record/array shape at exactly the requested address;
+ * answering it must not read the root payload, a sibling or an unrequested
+ * descendant. Presence and key-order facts at nested addresses are answered by
+ * the same reader's {@link ICompletedResultReader.readSelected}. Every answer is
+ * synchronous: storage that can only load asynchronously cannot implement this
+ * capability. Scalar-only readers need not implement it.
+ * @alpha
+ */
+export interface ICompletedNavigationReader {
+    /** Navigate to exactly one node of this reference, never following a current pointer. */
+    readNode(reference: ICompletedResultReference, address: readonly IAddressSegment[]): ISelectedNode;
+    /**
+     * Return the complete supported data of one container subtree, only for an
+     * explicit output request. Record key order must be the snapshot's order.
+     */
+    readSubtree(reference: ICompletedResultReference, address: readonly IAddressSegment[]): unknown;
+}
+//# sourceMappingURL=completed-results.d.ts.map

package/dist/src/completed-results.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"completed-results.d.ts","sourceRoot":"","sources":["../../src/completed-results.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EACV,eAAe,EACf,UAAU,EACV,aAAa,EACb,aAAa,EACb,0BAA0B,EAC1B,oBAAoB,EACrB,MAAM,mBAAmB,CAAC;AAE3B;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,8DAA8D;IAC9D,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAClC,6EAA6E;IAC7E,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,wFAAwF;AACxF,MAAM,WAAW,oBAAoB;IACnC,qDAAqD;IACrD,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;IAC/B,8DAA8D;IAC9D,QAAQ,CAAC,OAAO,EAAE,SAAS,eAAe,EAAE,CAAC;CAC9C;AAED;;;;;GAKG;AACH,MAAM,MAAM,2BAA2B,GACnC;IACE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;IAC/B,QAAQ,CAAC,OAAO,EAAE,SAAS,eAAe,EAAE,CAAC;IAC7C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,UAAU,EAAE,0BAA0B,CAAC;IAChD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,qBAAqB,CAAC;IACrC,QAAQ,CAAC,OAAO,EAAE,SAAS,eAAe,EAAE,CAAC;IAC7C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEN,2FAA2F;AAC3F,MAAM,MAAM,8BAA8B,GACtC;IAAE,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;CAAE,GAC7D;IAAE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAA;CAAE,GAChC;IAAE,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;CAAE,GACjC;IAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;CAAE,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC,+EAA+E;IAC/E,YAAY,CAAC,SAAS,EAAE,yBAAyB,EAAE,OAAO,EAAE,oBAAoB,GAAG,aAAa,CAAC;IACjG,oFAAoF;IACpF,kBAAkB,CAChB,SAAS,EAAE,yBAAyB,EACpC,OAAO,EAAE,2BAA2B,GACnC,8BAA8B,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,8EAA8E;IAC9E,cAAc,CACZ,SAAS,EAAE,yBAAyB,EACpC,UAAU,EAAE,0BAA0B,GACrC,oBAAoB,CAAC;CACzB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,0BAA0B;IACzC,yFAAyF;IACzF,QAAQ,CAAC,SAAS,EAAE,yBAAyB,EAAE,OAAO,EAAE,SAAS,eAAe,EAAE,GAAG,aAAa,CAAC;IACnG;;;OAGG;IACH,WAAW,CAAC,SAAS,EAAE,yBAAyB,EAAE,OAAO,EAAE,SAAS,eAAe,EAAE,GAAG,OAAO,CAAC;CACjG"}

package/dist/src/completed-results.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=completed-results.js.map

package/dist/src/completed-results.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"completed-results.js","sourceRoot":"","sources":["../../src/completed-results.ts"],"names":[],"mappings":""}