mindoodb 0.0.23 → 0.0.32

package/dist/core/extraction/types.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Attachment text extraction setup (docs/fulltext-search.md).
+ *
+ * Configures host-side extraction services (e.g. Haven's OCR service):
+ * which databases want expensive attachment-content extraction (OCR for
+ * images and scanned PDFs) whose results are persisted at the attachment
+ * entry via `MindooDoc.setAttachmentExtractedText()` and synced with the
+ * document. This is deliberately separate from `fulltextSetup.attachments`
+ * (cheap, index-local extractors that run on every device): extraction
+ * services run once per attachment, write the result into the document,
+ * and every replica gets the text for free.
+ *
+ * Stored in the synced setup document (`dbsetup`, field
+ * `extractionSetup`) — same pattern as `summarySetup`/`fulltextSetup`.
+ */
+export interface ExtractionConfig {
+    /** Master switch. Default: false (no extraction service activity). */
+    enabled?: boolean;
+    /**
+     * Tesseract-style language codes for OCR (e.g. ["deu", "eng"]).
+     * Services use this to load the matching trained data. Default is
+     * service-defined.
+     */
+    languages?: string[];
+    /**
+     * Restrict extraction to these MIME types (prefix match allowed, e.g.
+     * "image/"). Default: service-defined (typically images + PDFs).
+     */
+    mimeTypes?: string[];
+    /**
+     * Cap on persisted text per attachment in characters. Values above the
+     * hard limit (ATTACHMENT_EXTRACTED_TEXT_MAX_CHARS) are clamped by the
+     * write path.
+     */
+    maxCharsPerAttachment?: number;
+}
+/**
+ * Field of the `dbsetup` document holding the {@link ExtractionConfig}.
+ */
+export declare const EXTRACTION_SETUP_FIELD = "extractionSetup";
+/**
+ * Validate and strip an untrusted `extractionSetup` value from the setup
+ * document down to the known, well-typed fields. Returns `undefined` when
+ * the value is not an object — callers fall back to "not configured".
+ */
+export declare function sanitizeExtractionConfig(value: unknown): ExtractionConfig | undefined;
+//# sourceMappingURL=types.d.ts.map

package/dist/core/extraction/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/core/extraction/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,gBAAgB;IAC/B,sEAAsE;IACtE,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,eAAO,MAAM,sBAAsB,oBAAoB,CAAC;AAExD;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,GAAG,SAAS,CAiCrF"}

package/dist/core/extraction/types.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EXTRACTION_SETUP_FIELD = void 0;
+exports.sanitizeExtractionConfig = sanitizeExtractionConfig;
+/**
+ * Field of the `dbsetup` document holding the {@link ExtractionConfig}.
+ */
+exports.EXTRACTION_SETUP_FIELD = "extractionSetup";
+/**
+ * Validate and strip an untrusted `extractionSetup` value from the setup
+ * document down to the known, well-typed fields. Returns `undefined` when
+ * the value is not an object — callers fall back to "not configured".
+ */
+function sanitizeExtractionConfig(value) {
+    if (value === null || typeof value !== "object" || Array.isArray(value)) {
+        return undefined;
+    }
+    const raw = value;
+    const config = {};
+    if (typeof raw.enabled === "boolean") {
+        config.enabled = raw.enabled;
+    }
+    if (Array.isArray(raw.languages)) {
+        const languages = raw.languages.filter((item) => typeof item === "string" && item.length > 0 && item.length <= 35);
+        if (languages.length > 0) {
+            config.languages = languages;
+        }
+    }
+    if (Array.isArray(raw.mimeTypes)) {
+        const mimeTypes = raw.mimeTypes.filter((item) => typeof item === "string" && item.length > 0 && item.length <= 255);
+        if (mimeTypes.length > 0) {
+            config.mimeTypes = mimeTypes;
+        }
+    }
+    if (typeof raw.maxCharsPerAttachment === "number" &&
+        Number.isFinite(raw.maxCharsPerAttachment) &&
+        raw.maxCharsPerAttachment > 0) {
+        config.maxCharsPerAttachment = Math.floor(raw.maxCharsPerAttachment);
+    }
+    return config;
+}
+//# sourceMappingURL=types.js.map

package/dist/core/extraction/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/core/extraction/types.ts"],"names":[],"mappings":";;;AAkDA,4DAiCC;AA3CD;;GAEG;AACU,QAAA,sBAAsB,GAAG,iBAAiB,CAAC;AAExD;;;;GAIG;AACH,SAAgB,wBAAwB,CAAC,KAAc;IACrD,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACxE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,GAAG,GAAG,KAAgC,CAAC;IAC7C,MAAM,MAAM,GAAqB,EAAE,CAAC;IACpC,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACrC,MAAM,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IAC/B,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;QACjC,MAAM,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC,MAAM,CACpC,CAAC,IAAI,EAAkB,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,IAAI,EAAE,CAC3F,CAAC;QACF,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;QAC/B,CAAC;IACH,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;QACjC,MAAM,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC,MAAM,CACpC,CAAC,IAAI,EAAkB,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,CAC5F,CAAC;QACF,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;QAC/B,CAAC;IACH,CAAC;IACD,IACE,OAAO,GAAG,CAAC,qBAAqB,KAAK,QAAQ;QAC7C,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,qBAAqB,CAAC;QAC1C,GAAG,CAAC,qBAAqB,GAAG,CAAC,EAC7B,CAAC;QACD,MAAM,CAAC,qBAAqB,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/core/index.d.ts

@@ -1,6 +1,9 @@
 export * from "./types";
 export * from "./databaseIdValidation";
 export * from "./tenantIdValidation";
+export { ACCESS_CONTROL_FORM, ACL_DEFAULT_POLICY_DOC_ID, DEFAULT_POLICY_DEFAULTS, RULE_TYPES, RULE_TYPE_TO_DENY_FIELD, effectivePolicy, aclDbPolicyDocId, aclRuleDocId, aclTrustedWitnessDocId, encodeAclIdComponent, decodeAclIdComponent, aclKeyDistributionDocId, isKeyDistributionDocId, validateKeyDistribution, KEY_DISTRIBUTION_TYPE, ACL_KEY_DISTRIBUTION_PREFIX, PROTECTED_DISTRIBUTION_KEY_IDS, aclAppDistributionDocId, isAppDistributionDocId, validateAppDistribution, APP_DISTRIBUTION_TYPE, ACL_APP_DISTRIBUTION_PREFIX, aclSyncSetupPolicyDocId, isSyncSetupPolicyDocId, validateSyncSetupPolicy, SYNC_SETUP_POLICY_TYPE, SYNC_SETUP_POLICY_MODES, ACL_SYNC_SETUP_POLICY_PREFIX, aclDocHistoryPurgeDocId, isDocHistoryPurgeDocId, validateDocHistoryPurge, DOC_HISTORY_PURGE_TYPE, ACL_DOC_HISTORY_PURGE_PREFIX, type RuleType, type Operator, type WithFieldWhen, type WithFieldClause, type DefaultAccessPolicyDoc, type AclRuleDoc, type RuleTargets, type TrustedWitnessDoc, type AccessTier, type AccessDecision, type KeyVersionRef, type DeviceWrappedVersions, type KeyDistributionDoc, type KeyDistributionRequest, type KeyDistributionPushRecipient, type KeyDistributionView, type AppDistributionDoc, type AppDistributionRequest, type AppDistributionView, type AppDistributionInstall, type AppDistributionReconcilePlan, type SyncSetupPolicyDoc, type SyncSetupPolicyRequest, type SyncSetupPolicyView, type SyncSetupPolicyMode, type SyncSetupPolicyDatabase, type SyncSetupPolicyReconcilePlan, type DocHistoryPurgeDoc, type DocHistoryPurgeRequest, type DocHistoryPurgeView, } from "./accesscontrol/types";
+export { createGenesisNode, nodeCovering, type DirectoryStateNode, type UserGrantSnapshot, type GroupSnapshot, } from "./accesscontrol/DirectoryStateNode";
+export { AccessDeniedError } from "./accesscontrol/AccessDeniedError";
 export type { PublicUserId, PrivateUserId } from "./userid";
 export { BaseMindooDB } from "./BaseMindooDB";
 export { BaseMindooTenant } from "./BaseMindooTenant";
@@ -9,9 +12,10 @@ export { MindooDBServerAdmin, type MindooDBServerAdminOptions, type ServerConfig
 export type { CryptoAdapter } from "./crypto/CryptoAdapter";
 export { RSAEncryption } from "./crypto/RSAEncryption";
 export { MindooDocSigner } from "./crypto/MindooDocSigner";
+export { decryptEncryptedField, getEncryptedFieldKeyId, type EncryptedFieldDecryptor, } from "./crypto/encryptedFields";
 export { KeyBag, type KeyDetail } from "./keys/KeyBag";
-export { encodeMindooURI, decodeMindooURI, isMindooURI, type MindooURIType, type DecodedMindooURI, } from "./uri/MindooURI";
-export { SymmetricKeyNotFoundError } from "./errors";
+export { encodeMindooURI, decodeMindooURI, isMindooURI, encodeKeyDistributionRequest, decodeKeyDistributionRequest, encodeAppDistributionRequest, decodeAppDistributionRequest, encodeSyncSetupPolicyRequest, decodeSyncSetupPolicyRequest, encodeDocHistoryPurgeRequest, decodeDocHistoryPurgeRequest, type MindooURIType, type DecodedMindooURI, } from "./uri/MindooURI";
+export { SymmetricKeyNotFoundError, DocumentNotFoundError, DocumentDeletedError, isDocumentMissingError, } from "./errors";
 export type { LocalCacheStore } from "./cache/LocalCacheStore";
 export { InMemoryLocalCacheStore } from "./cache/LocalCacheStore";
 export { EncryptedLocalCacheStore } from "./cache/EncryptedLocalCacheStore";
@@ -24,5 +28,11 @@ export type { NetworkTransport, NetworkTransportConfig } from "./appendonlystore
 export { type NetworkEncryptedEntry, type UserPublicKeys, type NetworkAuthTokenPayload, type AuthChallenge, type AuthResult, type NetworkSyncCapabilities, NetworkErrorType, NetworkError, } from "./appendonlystores/network/types";
 export { ClientNetworkContentAddressedStore } from "../appendonlystores/network/ClientNetworkContentAddressedStore";
 export { HttpTransport } from "../appendonlystores/network/HttpTransport";
-export { VirtualView, VirtualViewFactory, VirtualViewBuilder, VirtualViewNavigatorBuilder, VirtualViewColumn, VirtualViewNavigator, VirtualViewEntryData, VirtualViewDataChange, MindooDBVirtualViewDataProvider, ColumnSorting, TotalMode, CategorizationStyle, WithCategories, WithDocuments, SelectedOnly, type VirtualViewColumnOptions, type IVirtualViewDataProvider, type MindooDBVirtualViewDataProviderOptions, type ScopedDocId, type ColumnValueFunction, type DocumentFilterFunction, } from "./indexing/virtualviews";
+export { VirtualView, VirtualViewFactory, VirtualViewBuilder, VirtualViewNavigatorBuilder, VirtualViewColumn, VirtualViewNavigator, VirtualViewEntryData, VirtualViewDataChange, MindooDBVirtualViewDataProvider, ColumnSorting, TotalMode, CategorizationStyle, WithCategories, WithDocuments, SelectedOnly, type VirtualViewColumnOptions, type IVirtualViewDataProvider, type MindooDBVirtualViewDataProviderOptions, type ScopedDocId, type ColumnValueFunction, type DocumentFilterFunction, type VirtualViewUpdateStats, type ViewDataSourceInfo, type WithDBOptions, } from "./indexing/virtualviews";
+export { createViewDataProvider, collectSummaryFallbackReasons, filterExpressionToDocumentFilter, type CreateViewDataProviderOptions, type CreateViewDataProviderResult, type ViewDataProviderSource, } from "./indexing/createViewDataProvider";
+export * from "./expressions";
+export { executeQuery, executeQueryLive, MindooQueryError, EphemeralSummaryView, createEphemeralSummaryView, queryViewAcross, type EphemeralViewSource, type MindooQuerySubscription, type MindooQueryViewDefinition, type MindooQuery, type MindooQuerySortKey, type MindooQueryTextClause, type MindooQueryErrorCode, type MindooQueryOptions, type MindooQueryRow, type MindooQueryCoverage, type MindooQueryResult, } from "./query";
+export { DocumentSummaryStore, SummaryVirtualViewDataProvider, type SummaryVirtualViewDataProviderOptions, resolveSummaryConfig, computeSummaryConfigFingerprint, sanitizeSummaryConfig, extractSummaryFields, getSummaryFieldValue, isFieldPathCovered, DEFAULT_SUMMARY_MAX_VALUE_BYTES, DB_SETUP_DOC_ID, SUMMARY_SETUP_FIELD, ATTACHMENTS_FIELD, type SummaryAttachmentInfo, type SummaryConfig, type ResolvedSummaryConfig, type DocumentSummaryEntry, type SummaryCoverage, } from "./indexing/summary";
+export { DocumentFullTextIndex, MiniSearchAdapter, createTokenizer, resolveFulltextConfig, sanitizeFulltextConfig, computeFulltextConfigFingerprint, collectPlainText, extractFulltextFields, FULLTEXT_SETUP_FIELD, FULLTEXT_ATTACHMENT_FIELD, FULLTEXT_INDEX_FORMAT_VERSION, DEFAULT_FULLTEXT_MAX_FIELD_BYTES, type SearchEngineAdapter, type FulltextConfig, type ResolvedFulltextConfig, type FulltextCoverage, type FulltextSearchHit, type FulltextSearchOptions, type FulltextSearchResult, type AttachmentTextExtractor, } from "./indexing/fulltext";
+export { EXTRACTION_SETUP_FIELD, sanitizeExtractionConfig, type ExtractionConfig, } from "./extraction/types";
 //# sourceMappingURL=index.d.ts.map

package/dist/core/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":"AAGA,cAAc,SAAS,CAAC;AACxB,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AAGrC,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAG5D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,OAAO,EACL,mBAAmB,EACnB,KAAK,0BAA0B,EAC/B,KAAK,YAAY,EACjB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,GAC1B,MAAM,uBAAuB,CAAC;AAG/B,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAG3D,OAAO,EAAE,MAAM,EAAE,KAAK,SAAS,EAAE,MAAM,eAAe,CAAC;AAGvD,OAAO,EACL,eAAe,EACf,eAAe,EACf,WAAW,EACX,KAAK,aAAa,EAClB,KAAK,gBAAgB,GACtB,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAC;AAGrD,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,EAAE,YAAY,EAAE,KAAK,UAAU,EAAE,KAAK,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAG/F,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,yBAAyB,EACzB,iBAAiB,EACjB,kBAAkB,EAClB,eAAe,EACf,sBAAsB,EACtB,YAAY,EACZ,mBAAmB,EACnB,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,SAAS,CAAC;AAGjB,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,0BAA0B,EAC/B,KAAK,8BAA8B,EACnC,KAAK,2BAA2B,EAChC,KAAK,gCAAgC,GACtC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,6BAA6B,EAAE,oCAAoC,EAAE,MAAM,kDAAkD,CAAC;AAGvI,OAAO,EAAE,qBAAqB,EAAE,MAAM,kDAAkD,CAAC;AACzF,YAAY,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,6CAA6C,CAAC;AAC5G,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,cAAc,EACnB,KAAK,uBAAuB,EAC5B,KAAK,aAAa,EAClB,KAAK,UAAU,EACf,KAAK,uBAAuB,EAC5B,gBAAgB,EAChB,YAAY,GACb,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,kCAAkC,EAAE,MAAM,gEAAgE,CAAC;AACpH,OAAO,EAAE,aAAa,EAAE,MAAM,2CAA2C,CAAC;AAG1E,OAAO,EACL,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,2BAA2B,EAC3B,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,+BAA+B,EAC/B,aAAa,EACb,SAAS,EACT,mBAAmB,EACnB,cAAc,EACd,aAAa,EACb,YAAY,EACZ,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,sCAAsC,EAC3C,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,GAC5B,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":"AAGA,cAAc,SAAS,CAAC;AACxB,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AAMrC,OAAO,EACL,mBAAmB,EACnB,yBAAyB,EACzB,uBAAuB,EACvB,UAAU,EACV,uBAAuB,EACvB,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACvB,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,2BAA2B,EAC3B,8BAA8B,EAC9B,uBAAuB,EACvB,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,2BAA2B,EAC3B,uBAAuB,EACvB,sBAAsB,EACtB,uBAAuB,EACvB,sBAAsB,EACtB,uBAAuB,EACvB,4BAA4B,EAC5B,uBAAuB,EACvB,sBAAsB,EACtB,uBAAuB,EACvB,sBAAsB,EACtB,4BAA4B,EAC5B,KAAK,QAAQ,EACb,KAAK,QAAQ,EACb,KAAK,aAAa,EAClB,KAAK,eAAe,EACpB,KAAK,sBAAsB,EAC3B,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,iBAAiB,EACtB,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,4BAA4B,EACjC,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,4BAA4B,EACjC,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,4BAA4B,EACjC,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,mBAAmB,GACzB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,iBAAiB,EACjB,YAAY,EACZ,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,aAAa,GACnB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AAGtE,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAG5D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,OAAO,EACL,mBAAmB,EACnB,KAAK,0BAA0B,EAC/B,KAAK,YAAY,EACjB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,GAC1B,MAAM,uBAAuB,CAAC;AAG/B,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,KAAK,uBAAuB,GAC7B,MAAM,0BAA0B,CAAC;AAGlC,OAAO,EAAE,MAAM,EAAE,KAAK,SAAS,EAAE,MAAM,eAAe,CAAC;AAGvD,OAAO,EACL,eAAe,EACf,eAAe,EACf,WAAW,EACX,4BAA4B,EAC5B,4BAA4B,EAC5B,4BAA4B,EAC5B,4BAA4B,EAC5B,4BAA4B,EAC5B,4BAA4B,EAC5B,4BAA4B,EAC5B,4BAA4B,EAC5B,KAAK,aAAa,EAClB,KAAK,gBAAgB,GACtB,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EACL,yBAAyB,EACzB,qBAAqB,EACrB,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,UAAU,CAAC;AAGlB,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,EAAE,YAAY,EAAE,KAAK,UAAU,EAAE,KAAK,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAG/F,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,yBAAyB,EACzB,iBAAiB,EACjB,kBAAkB,EAClB,eAAe,EACf,sBAAsB,EACtB,YAAY,EACZ,mBAAmB,EACnB,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,SAAS,CAAC;AAGjB,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,0BAA0B,EAC/B,KAAK,8BAA8B,EACnC,KAAK,2BAA2B,EAChC,KAAK,gCAAgC,GACtC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,6BAA6B,EAAE,oCAAoC,EAAE,MAAM,kDAAkD,CAAC;AAGvI,OAAO,EAAE,qBAAqB,EAAE,MAAM,kDAAkD,CAAC;AACzF,YAAY,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,6CAA6C,CAAC;AAC5G,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,cAAc,EACnB,KAAK,uBAAuB,EAC5B,KAAK,aAAa,EAClB,KAAK,UAAU,EACf,KAAK,uBAAuB,EAC5B,gBAAgB,EAChB,YAAY,GACb,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,kCAAkC,EAAE,MAAM,gEAAgE,CAAC;AACpH,OAAO,EAAE,aAAa,EAAE,MAAM,2CAA2C,CAAC;AAG1E,OAAO,EACL,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,2BAA2B,EAC3B,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,+BAA+B,EAC/B,aAAa,EACb,SAAS,EACT,mBAAmB,EACnB,cAAc,EACd,aAAa,EACb,YAAY,EACZ,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,sCAAsC,EAC3C,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,aAAa,GACnB,MAAM,yBAAyB,CAAC;AAIjC,OAAO,EACL,sBAAsB,EACtB,6BAA6B,EAC7B,gCAAgC,EAChC,KAAK,6BAA6B,EAClC,KAAK,4BAA4B,EACjC,KAAK,sBAAsB,GAC5B,MAAM,mCAAmC,CAAC;AAI3C,cAAc,eAAe,CAAC;AAG9B,OAAO,EACL,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,oBAAoB,EACpB,0BAA0B,EAC1B,eAAe,EACf,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,yBAAyB,EAC9B,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,GACvB,MAAM,SAAS,CAAC;AAGjB,OAAO,EACL,oBAAoB,EACpB,8BAA8B,EAC9B,KAAK,qCAAqC,EAC1C,oBAAoB,EACpB,+BAA+B,EAC/B,qBAAqB,EACrB,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,+BAA+B,EAC/B,eAAe,EACf,mBAAmB,EACnB,iBAAiB,EACjB,KAAK,qBAAqB,EAC1B,KAAK,aAAa,EAClB,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,eAAe,GACrB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,qBAAqB,EACrB,sBAAsB,EACtB,gCAAgC,EAChC,gBAAgB,EAChB,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,6BAA6B,EAC7B,gCAAgC,EAChC,KAAK,mBAAmB,EACxB,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,GAC7B,MAAM,qBAAqB,CAAC;AAI7B,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,KAAK,gBAAgB,GACtB,MAAM,oBAAoB,CAAC"}

package/dist/core/index.js

@@ -15,11 +15,56 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SelectedOnly = exports.WithDocuments = exports.WithCategories = exports.CategorizationStyle = exports.TotalMode = exports.ColumnSorting = exports.MindooDBVirtualViewDataProvider = exports.VirtualViewDataChange = exports.VirtualViewEntryData = exports.VirtualViewNavigator = exports.VirtualViewColumn = exports.VirtualViewNavigatorBuilder = exports.VirtualViewBuilder = exports.VirtualViewFactory = exports.VirtualView = exports.HttpTransport = exports.ClientNetworkContentAddressedStore = exports.NetworkError = exports.NetworkErrorType = exports.AuthenticationService = exports.InMemoryContentAddressedStoreFactory = exports.InMemoryContentAddressedStore = exports.computeContentHash = exports.extractDocIdFromEntryId = exports.isAttachmentChunkId = exports.isDocEntryId = exports.parseAttachmentChunkId = exports.parseDocEntryId = exports.generateChunkUuid7 = exports.generateFileUuid7 = exports.generateAttachmentChunkId = exports.generateDepsFingerprint = exports.generateDocEntryId = exports.CacheManager = exports.EncryptedLocalCacheStore = exports.InMemoryLocalCacheStore = exports.SymmetricKeyNotFoundError = exports.isMindooURI = exports.decodeMindooURI = exports.encodeMindooURI = exports.KeyBag = exports.MindooDocSigner = exports.RSAEncryption = exports.MindooDBServerAdmin = exports.BaseMindooTenantFactory = exports.BaseMindooTenant = exports.BaseMindooDB = void 0;
+exports.decodeKeyDistributionRequest = exports.encodeKeyDistributionRequest = exports.isMindooURI = exports.decodeMindooURI = exports.encodeMindooURI = exports.KeyBag = exports.getEncryptedFieldKeyId = exports.decryptEncryptedField = exports.MindooDocSigner = exports.RSAEncryption = exports.MindooDBServerAdmin = exports.BaseMindooTenantFactory = exports.BaseMindooTenant = exports.BaseMindooDB = exports.AccessDeniedError = exports.nodeCovering = exports.createGenesisNode = exports.ACL_DOC_HISTORY_PURGE_PREFIX = exports.DOC_HISTORY_PURGE_TYPE = exports.validateDocHistoryPurge = exports.isDocHistoryPurgeDocId = exports.aclDocHistoryPurgeDocId = exports.ACL_SYNC_SETUP_POLICY_PREFIX = exports.SYNC_SETUP_POLICY_MODES = exports.SYNC_SETUP_POLICY_TYPE = exports.validateSyncSetupPolicy = exports.isSyncSetupPolicyDocId = exports.aclSyncSetupPolicyDocId = exports.ACL_APP_DISTRIBUTION_PREFIX = exports.APP_DISTRIBUTION_TYPE = exports.validateAppDistribution = exports.isAppDistributionDocId = exports.aclAppDistributionDocId = exports.PROTECTED_DISTRIBUTION_KEY_IDS = exports.ACL_KEY_DISTRIBUTION_PREFIX = exports.KEY_DISTRIBUTION_TYPE = exports.validateKeyDistribution = exports.isKeyDistributionDocId = exports.aclKeyDistributionDocId = exports.decodeAclIdComponent = exports.encodeAclIdComponent = exports.aclTrustedWitnessDocId = exports.aclRuleDocId = exports.aclDbPolicyDocId = exports.effectivePolicy = exports.RULE_TYPE_TO_DENY_FIELD = exports.RULE_TYPES = exports.DEFAULT_POLICY_DEFAULTS = exports.ACL_DEFAULT_POLICY_DOC_ID = exports.ACCESS_CONTROL_FORM = void 0;
+exports.executeQuery = exports.filterExpressionToDocumentFilter = exports.collectSummaryFallbackReasons = exports.createViewDataProvider = exports.SelectedOnly = exports.WithDocuments = exports.WithCategories = exports.CategorizationStyle = exports.TotalMode = exports.ColumnSorting = exports.MindooDBVirtualViewDataProvider = exports.VirtualViewDataChange = exports.VirtualViewEntryData = exports.VirtualViewNavigator = exports.VirtualViewColumn = exports.VirtualViewNavigatorBuilder = exports.VirtualViewBuilder = exports.VirtualViewFactory = exports.VirtualView = exports.HttpTransport = exports.ClientNetworkContentAddressedStore = exports.NetworkError = exports.NetworkErrorType = exports.AuthenticationService = exports.InMemoryContentAddressedStoreFactory = exports.InMemoryContentAddressedStore = exports.computeContentHash = exports.extractDocIdFromEntryId = exports.isAttachmentChunkId = exports.isDocEntryId = exports.parseAttachmentChunkId = exports.parseDocEntryId = exports.generateChunkUuid7 = exports.generateFileUuid7 = exports.generateAttachmentChunkId = exports.generateDepsFingerprint = exports.generateDocEntryId = exports.CacheManager = exports.EncryptedLocalCacheStore = exports.InMemoryLocalCacheStore = exports.isDocumentMissingError = exports.DocumentDeletedError = exports.DocumentNotFoundError = exports.SymmetricKeyNotFoundError = exports.decodeDocHistoryPurgeRequest = exports.encodeDocHistoryPurgeRequest = exports.decodeSyncSetupPolicyRequest = exports.encodeSyncSetupPolicyRequest = exports.decodeAppDistributionRequest = exports.encodeAppDistributionRequest = void 0;
+exports.sanitizeExtractionConfig = exports.EXTRACTION_SETUP_FIELD = exports.DEFAULT_FULLTEXT_MAX_FIELD_BYTES = exports.FULLTEXT_INDEX_FORMAT_VERSION = exports.FULLTEXT_ATTACHMENT_FIELD = exports.FULLTEXT_SETUP_FIELD = exports.extractFulltextFields = exports.collectPlainText = exports.computeFulltextConfigFingerprint = exports.sanitizeFulltextConfig = exports.resolveFulltextConfig = exports.createTokenizer = exports.MiniSearchAdapter = exports.DocumentFullTextIndex = exports.ATTACHMENTS_FIELD = exports.SUMMARY_SETUP_FIELD = exports.DB_SETUP_DOC_ID = exports.DEFAULT_SUMMARY_MAX_VALUE_BYTES = exports.isFieldPathCovered = exports.getSummaryFieldValue = exports.extractSummaryFields = exports.sanitizeSummaryConfig = exports.computeSummaryConfigFingerprint = exports.resolveSummaryConfig = exports.SummaryVirtualViewDataProvider = exports.DocumentSummaryStore = exports.queryViewAcross = exports.createEphemeralSummaryView = exports.EphemeralSummaryView = exports.MindooQueryError = exports.executeQueryLive = void 0;
 // Types
 __exportStar(require("./types"), exports);
 __exportStar(require("./databaseIdValidation"), exports);
 __exportStar(require("./tenantIdValidation"), exports);
+// Access-control directory schema + time-travel state (docs/accesscontrol.md
+// §6/§8). Surfaced so consumers (e.g. the Haven directory-history UI) can read
+// the time-travel DirectoryStateNode returned by
+// MindooTenantDirectory.getDirectoryStateAt / getDirectoryStateHead.
+var types_1 = require("./accesscontrol/types");
+Object.defineProperty(exports, "ACCESS_CONTROL_FORM", { enumerable: true, get: function () { return types_1.ACCESS_CONTROL_FORM; } });
+Object.defineProperty(exports, "ACL_DEFAULT_POLICY_DOC_ID", { enumerable: true, get: function () { return types_1.ACL_DEFAULT_POLICY_DOC_ID; } });
+Object.defineProperty(exports, "DEFAULT_POLICY_DEFAULTS", { enumerable: true, get: function () { return types_1.DEFAULT_POLICY_DEFAULTS; } });
+Object.defineProperty(exports, "RULE_TYPES", { enumerable: true, get: function () { return types_1.RULE_TYPES; } });
+Object.defineProperty(exports, "RULE_TYPE_TO_DENY_FIELD", { enumerable: true, get: function () { return types_1.RULE_TYPE_TO_DENY_FIELD; } });
+Object.defineProperty(exports, "effectivePolicy", { enumerable: true, get: function () { return types_1.effectivePolicy; } });
+Object.defineProperty(exports, "aclDbPolicyDocId", { enumerable: true, get: function () { return types_1.aclDbPolicyDocId; } });
+Object.defineProperty(exports, "aclRuleDocId", { enumerable: true, get: function () { return types_1.aclRuleDocId; } });
+Object.defineProperty(exports, "aclTrustedWitnessDocId", { enumerable: true, get: function () { return types_1.aclTrustedWitnessDocId; } });
+Object.defineProperty(exports, "encodeAclIdComponent", { enumerable: true, get: function () { return types_1.encodeAclIdComponent; } });
+Object.defineProperty(exports, "decodeAclIdComponent", { enumerable: true, get: function () { return types_1.decodeAclIdComponent; } });
+Object.defineProperty(exports, "aclKeyDistributionDocId", { enumerable: true, get: function () { return types_1.aclKeyDistributionDocId; } });
+Object.defineProperty(exports, "isKeyDistributionDocId", { enumerable: true, get: function () { return types_1.isKeyDistributionDocId; } });
+Object.defineProperty(exports, "validateKeyDistribution", { enumerable: true, get: function () { return types_1.validateKeyDistribution; } });
+Object.defineProperty(exports, "KEY_DISTRIBUTION_TYPE", { enumerable: true, get: function () { return types_1.KEY_DISTRIBUTION_TYPE; } });
+Object.defineProperty(exports, "ACL_KEY_DISTRIBUTION_PREFIX", { enumerable: true, get: function () { return types_1.ACL_KEY_DISTRIBUTION_PREFIX; } });
+Object.defineProperty(exports, "PROTECTED_DISTRIBUTION_KEY_IDS", { enumerable: true, get: function () { return types_1.PROTECTED_DISTRIBUTION_KEY_IDS; } });
+Object.defineProperty(exports, "aclAppDistributionDocId", { enumerable: true, get: function () { return types_1.aclAppDistributionDocId; } });
+Object.defineProperty(exports, "isAppDistributionDocId", { enumerable: true, get: function () { return types_1.isAppDistributionDocId; } });
+Object.defineProperty(exports, "validateAppDistribution", { enumerable: true, get: function () { return types_1.validateAppDistribution; } });
+Object.defineProperty(exports, "APP_DISTRIBUTION_TYPE", { enumerable: true, get: function () { return types_1.APP_DISTRIBUTION_TYPE; } });
+Object.defineProperty(exports, "ACL_APP_DISTRIBUTION_PREFIX", { enumerable: true, get: function () { return types_1.ACL_APP_DISTRIBUTION_PREFIX; } });
+Object.defineProperty(exports, "aclSyncSetupPolicyDocId", { enumerable: true, get: function () { return types_1.aclSyncSetupPolicyDocId; } });
+Object.defineProperty(exports, "isSyncSetupPolicyDocId", { enumerable: true, get: function () { return types_1.isSyncSetupPolicyDocId; } });
+Object.defineProperty(exports, "validateSyncSetupPolicy", { enumerable: true, get: function () { return types_1.validateSyncSetupPolicy; } });
+Object.defineProperty(exports, "SYNC_SETUP_POLICY_TYPE", { enumerable: true, get: function () { return types_1.SYNC_SETUP_POLICY_TYPE; } });
+Object.defineProperty(exports, "SYNC_SETUP_POLICY_MODES", { enumerable: true, get: function () { return types_1.SYNC_SETUP_POLICY_MODES; } });
+Object.defineProperty(exports, "ACL_SYNC_SETUP_POLICY_PREFIX", { enumerable: true, get: function () { return types_1.ACL_SYNC_SETUP_POLICY_PREFIX; } });
+Object.defineProperty(exports, "aclDocHistoryPurgeDocId", { enumerable: true, get: function () { return types_1.aclDocHistoryPurgeDocId; } });
+Object.defineProperty(exports, "isDocHistoryPurgeDocId", { enumerable: true, get: function () { return types_1.isDocHistoryPurgeDocId; } });
+Object.defineProperty(exports, "validateDocHistoryPurge", { enumerable: true, get: function () { return types_1.validateDocHistoryPurge; } });
+Object.defineProperty(exports, "DOC_HISTORY_PURGE_TYPE", { enumerable: true, get: function () { return types_1.DOC_HISTORY_PURGE_TYPE; } });
+Object.defineProperty(exports, "ACL_DOC_HISTORY_PURGE_PREFIX", { enumerable: true, get: function () { return types_1.ACL_DOC_HISTORY_PURGE_PREFIX; } });
+var DirectoryStateNode_1 = require("./accesscontrol/DirectoryStateNode");
+Object.defineProperty(exports, "createGenesisNode", { enumerable: true, get: function () { return DirectoryStateNode_1.createGenesisNode; } });
+Object.defineProperty(exports, "nodeCovering", { enumerable: true, get: function () { return DirectoryStateNode_1.nodeCovering; } });
+var AccessDeniedError_1 = require("./accesscontrol/AccessDeniedError");
+Object.defineProperty(exports, "AccessDeniedError", { enumerable: true, get: function () { return AccessDeniedError_1.AccessDeniedError; } });
 // Base classes
 var BaseMindooDB_1 = require("./BaseMindooDB");
 Object.defineProperty(exports, "BaseMindooDB", { enumerable: true, get: function () { return BaseMindooDB_1.BaseMindooDB; } });
@@ -33,6 +78,9 @@ var RSAEncryption_1 = require("./crypto/RSAEncryption");
 Object.defineProperty(exports, "RSAEncryption", { enumerable: true, get: function () { return RSAEncryption_1.RSAEncryption; } });
 var MindooDocSigner_1 = require("./crypto/MindooDocSigner");
 Object.defineProperty(exports, "MindooDocSigner", { enumerable: true, get: function () { return MindooDocSigner_1.MindooDocSigner; } });
+var encryptedFields_1 = require("./crypto/encryptedFields");
+Object.defineProperty(exports, "decryptEncryptedField", { enumerable: true, get: function () { return encryptedFields_1.decryptEncryptedField; } });
+Object.defineProperty(exports, "getEncryptedFieldKeyId", { enumerable: true, get: function () { return encryptedFields_1.getEncryptedFieldKeyId; } });
 // Keys
 var KeyBag_1 = require("./keys/KeyBag");
 Object.defineProperty(exports, "KeyBag", { enumerable: true, get: function () { return KeyBag_1.KeyBag; } });
@@ -41,9 +89,20 @@ var MindooURI_1 = require("./uri/MindooURI");
 Object.defineProperty(exports, "encodeMindooURI", { enumerable: true, get: function () { return MindooURI_1.encodeMindooURI; } });
 Object.defineProperty(exports, "decodeMindooURI", { enumerable: true, get: function () { return MindooURI_1.decodeMindooURI; } });
 Object.defineProperty(exports, "isMindooURI", { enumerable: true, get: function () { return MindooURI_1.isMindooURI; } });
+Object.defineProperty(exports, "encodeKeyDistributionRequest", { enumerable: true, get: function () { return MindooURI_1.encodeKeyDistributionRequest; } });
+Object.defineProperty(exports, "decodeKeyDistributionRequest", { enumerable: true, get: function () { return MindooURI_1.decodeKeyDistributionRequest; } });
+Object.defineProperty(exports, "encodeAppDistributionRequest", { enumerable: true, get: function () { return MindooURI_1.encodeAppDistributionRequest; } });
+Object.defineProperty(exports, "decodeAppDistributionRequest", { enumerable: true, get: function () { return MindooURI_1.decodeAppDistributionRequest; } });
+Object.defineProperty(exports, "encodeSyncSetupPolicyRequest", { enumerable: true, get: function () { return MindooURI_1.encodeSyncSetupPolicyRequest; } });
+Object.defineProperty(exports, "decodeSyncSetupPolicyRequest", { enumerable: true, get: function () { return MindooURI_1.decodeSyncSetupPolicyRequest; } });
+Object.defineProperty(exports, "encodeDocHistoryPurgeRequest", { enumerable: true, get: function () { return MindooURI_1.encodeDocHistoryPurgeRequest; } });
+Object.defineProperty(exports, "decodeDocHistoryPurgeRequest", { enumerable: true, get: function () { return MindooURI_1.decodeDocHistoryPurgeRequest; } });
 // Errors
 var errors_1 = require("./errors");
 Object.defineProperty(exports, "SymmetricKeyNotFoundError", { enumerable: true, get: function () { return errors_1.SymmetricKeyNotFoundError; } });
+Object.defineProperty(exports, "DocumentNotFoundError", { enumerable: true, get: function () { return errors_1.DocumentNotFoundError; } });
+Object.defineProperty(exports, "DocumentDeletedError", { enumerable: true, get: function () { return errors_1.DocumentDeletedError; } });
+Object.defineProperty(exports, "isDocumentMissingError", { enumerable: true, get: function () { return errors_1.isDocumentMissingError; } });
 var LocalCacheStore_1 = require("./cache/LocalCacheStore");
 Object.defineProperty(exports, "InMemoryLocalCacheStore", { enumerable: true, get: function () { return LocalCacheStore_1.InMemoryLocalCacheStore; } });
 var EncryptedLocalCacheStore_1 = require("./cache/EncryptedLocalCacheStore");
@@ -69,9 +128,9 @@ Object.defineProperty(exports, "InMemoryContentAddressedStoreFactory", { enumera
 // Network
 var AuthenticationService_1 = require("./appendonlystores/network/AuthenticationService");
 Object.defineProperty(exports, "AuthenticationService", { enumerable: true, get: function () { return AuthenticationService_1.AuthenticationService; } });
-var types_1 = require("./appendonlystores/network/types");
-Object.defineProperty(exports, "NetworkErrorType", { enumerable: true, get: function () { return types_1.NetworkErrorType; } });
-Object.defineProperty(exports, "NetworkError", { enumerable: true, get: function () { return types_1.NetworkError; } });
+var types_2 = require("./appendonlystores/network/types");
+Object.defineProperty(exports, "NetworkErrorType", { enumerable: true, get: function () { return types_2.NetworkErrorType; } });
+Object.defineProperty(exports, "NetworkError", { enumerable: true, get: function () { return types_2.NetworkError; } });
 var ClientNetworkContentAddressedStore_1 = require("../appendonlystores/network/ClientNetworkContentAddressedStore");
 Object.defineProperty(exports, "ClientNetworkContentAddressedStore", { enumerable: true, get: function () { return ClientNetworkContentAddressedStore_1.ClientNetworkContentAddressedStore; } });
 var HttpTransport_1 = require("../appendonlystores/network/HttpTransport");
@@ -93,4 +152,54 @@ Object.defineProperty(exports, "CategorizationStyle", { enumerable: true, get: f
 Object.defineProperty(exports, "WithCategories", { enumerable: true, get: function () { return virtualviews_1.WithCategories; } });
 Object.defineProperty(exports, "WithDocuments", { enumerable: true, get: function () { return virtualviews_1.WithDocuments; } });
 Object.defineProperty(exports, "SelectedOnly", { enumerable: true, get: function () { return virtualviews_1.SelectedOnly; } });
+// Summary-first data provider factory (summary buffer when possible,
+// materialized documents on request/fallback)
+var createViewDataProvider_1 = require("./indexing/createViewDataProvider");
+Object.defineProperty(exports, "createViewDataProvider", { enumerable: true, get: function () { return createViewDataProvider_1.createViewDataProvider; } });
+Object.defineProperty(exports, "collectSummaryFallbackReasons", { enumerable: true, get: function () { return createViewDataProvider_1.collectSummaryFallbackReasons; } });
+Object.defineProperty(exports, "filterExpressionToDocumentFilter", { enumerable: true, get: function () { return createViewDataProvider_1.filterExpressionToDocumentFilter; } });
+// Expression language (formerly mindoodb-view-language; that package
+// re-exports these symbols as a compatibility wrapper)
+__exportStar(require("./expressions"), exports);
+// Ad-hoc query engine over the document summary buffer
+var query_1 = require("./query");
+Object.defineProperty(exports, "executeQuery", { enumerable: true, get: function () { return query_1.executeQuery; } });
+Object.defineProperty(exports, "executeQueryLive", { enumerable: true, get: function () { return query_1.executeQueryLive; } });
+Object.defineProperty(exports, "MindooQueryError", { enumerable: true, get: function () { return query_1.MindooQueryError; } });
+Object.defineProperty(exports, "EphemeralSummaryView", { enumerable: true, get: function () { return query_1.EphemeralSummaryView; } });
+Object.defineProperty(exports, "createEphemeralSummaryView", { enumerable: true, get: function () { return query_1.createEphemeralSummaryView; } });
+Object.defineProperty(exports, "queryViewAcross", { enumerable: true, get: function () { return query_1.queryViewAcross; } });
+// Indexing - Document summary buffer (ad-hoc query substrate)
+var summary_1 = require("./indexing/summary");
+Object.defineProperty(exports, "DocumentSummaryStore", { enumerable: true, get: function () { return summary_1.DocumentSummaryStore; } });
+Object.defineProperty(exports, "SummaryVirtualViewDataProvider", { enumerable: true, get: function () { return summary_1.SummaryVirtualViewDataProvider; } });
+Object.defineProperty(exports, "resolveSummaryConfig", { enumerable: true, get: function () { return summary_1.resolveSummaryConfig; } });
+Object.defineProperty(exports, "computeSummaryConfigFingerprint", { enumerable: true, get: function () { return summary_1.computeSummaryConfigFingerprint; } });
+Object.defineProperty(exports, "sanitizeSummaryConfig", { enumerable: true, get: function () { return summary_1.sanitizeSummaryConfig; } });
+Object.defineProperty(exports, "extractSummaryFields", { enumerable: true, get: function () { return summary_1.extractSummaryFields; } });
+Object.defineProperty(exports, "getSummaryFieldValue", { enumerable: true, get: function () { return summary_1.getSummaryFieldValue; } });
+Object.defineProperty(exports, "isFieldPathCovered", { enumerable: true, get: function () { return summary_1.isFieldPathCovered; } });
+Object.defineProperty(exports, "DEFAULT_SUMMARY_MAX_VALUE_BYTES", { enumerable: true, get: function () { return summary_1.DEFAULT_SUMMARY_MAX_VALUE_BYTES; } });
+Object.defineProperty(exports, "DB_SETUP_DOC_ID", { enumerable: true, get: function () { return summary_1.DB_SETUP_DOC_ID; } });
+Object.defineProperty(exports, "SUMMARY_SETUP_FIELD", { enumerable: true, get: function () { return summary_1.SUMMARY_SETUP_FIELD; } });
+Object.defineProperty(exports, "ATTACHMENTS_FIELD", { enumerable: true, get: function () { return summary_1.ATTACHMENTS_FIELD; } });
+// Indexing - Document full-text index (opt-in, see docs/fulltext-search.md)
+var fulltext_1 = require("./indexing/fulltext");
+Object.defineProperty(exports, "DocumentFullTextIndex", { enumerable: true, get: function () { return fulltext_1.DocumentFullTextIndex; } });
+Object.defineProperty(exports, "MiniSearchAdapter", { enumerable: true, get: function () { return fulltext_1.MiniSearchAdapter; } });
+Object.defineProperty(exports, "createTokenizer", { enumerable: true, get: function () { return fulltext_1.createTokenizer; } });
+Object.defineProperty(exports, "resolveFulltextConfig", { enumerable: true, get: function () { return fulltext_1.resolveFulltextConfig; } });
+Object.defineProperty(exports, "sanitizeFulltextConfig", { enumerable: true, get: function () { return fulltext_1.sanitizeFulltextConfig; } });
+Object.defineProperty(exports, "computeFulltextConfigFingerprint", { enumerable: true, get: function () { return fulltext_1.computeFulltextConfigFingerprint; } });
+Object.defineProperty(exports, "collectPlainText", { enumerable: true, get: function () { return fulltext_1.collectPlainText; } });
+Object.defineProperty(exports, "extractFulltextFields", { enumerable: true, get: function () { return fulltext_1.extractFulltextFields; } });
+Object.defineProperty(exports, "FULLTEXT_SETUP_FIELD", { enumerable: true, get: function () { return fulltext_1.FULLTEXT_SETUP_FIELD; } });
+Object.defineProperty(exports, "FULLTEXT_ATTACHMENT_FIELD", { enumerable: true, get: function () { return fulltext_1.FULLTEXT_ATTACHMENT_FIELD; } });
+Object.defineProperty(exports, "FULLTEXT_INDEX_FORMAT_VERSION", { enumerable: true, get: function () { return fulltext_1.FULLTEXT_INDEX_FORMAT_VERSION; } });
+Object.defineProperty(exports, "DEFAULT_FULLTEXT_MAX_FIELD_BYTES", { enumerable: true, get: function () { return fulltext_1.DEFAULT_FULLTEXT_MAX_FIELD_BYTES; } });
+// Attachment text extraction setup (host-side services like Haven's OCR;
+// results are persisted at the attachment entry, see docs/fulltext-search.md)
+var types_3 = require("./extraction/types");
+Object.defineProperty(exports, "EXTRACTION_SETUP_FIELD", { enumerable: true, get: function () { return types_3.EXTRACTION_SETUP_FIELD; } });
+Object.defineProperty(exports, "sanitizeExtractionConfig", { enumerable: true, get: function () { return types_3.sanitizeExtractionConfig; } });
 //# sourceMappingURL=index.js.map

package/dist/core/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":";AAAA,iCAAiC;;;;;;;;;;;;;;;;;AAEjC,QAAQ;AACR,0CAAwB;AACxB,yDAAuC;AACvC,uDAAqC;AAKrC,eAAe;AACf,+CAA8C;AAArC,4GAAA,YAAY,OAAA;AACrB,uDAAsD;AAA7C,oHAAA,gBAAgB,OAAA;AACzB,qEAAoE;AAA3D,kIAAA,uBAAuB,OAAA;AAEhC,6DAO+B;AAN7B,0HAAA,mBAAmB,OAAA;AAUrB,wDAAuD;AAA9C,8GAAA,aAAa,OAAA;AACtB,4DAA2D;AAAlD,kHAAA,eAAe,OAAA;AAExB,OAAO;AACP,wCAAuD;AAA9C,gGAAA,MAAM,OAAA;AAEf,MAAM;AACN,6CAMyB;AALvB,4GAAA,eAAe,OAAA;AACf,4GAAA,eAAe,OAAA;AACf,wGAAA,WAAW,OAAA;AAKb,SAAS;AACT,mCAAqD;AAA5C,mHAAA,yBAAyB,OAAA;AAIlC,2DAAkE;AAAzD,0HAAA,uBAAuB,OAAA;AAChC,6EAA4E;AAAnE,oIAAA,wBAAwB,OAAA;AACjC,qDAA+F;AAAtF,4GAAA,YAAY,OAAA;AAErB,YAAY;AACZ,iCAYiB;AAXf,2GAAA,kBAAkB,OAAA;AAClB,gHAAA,uBAAuB,OAAA;AACvB,kHAAA,yBAAyB,OAAA;AACzB,0GAAA,iBAAiB,OAAA;AACjB,2GAAA,kBAAkB,OAAA;AAClB,wGAAA,eAAe,OAAA;AACf,+GAAA,sBAAsB,OAAA;AACtB,qGAAA,YAAY,OAAA;AACZ,4GAAA,mBAAmB,OAAA;AACnB,gHAAA,uBAAuB,OAAA;AACvB,2GAAA,kBAAkB,OAAA;AAmBpB,kGAAuI;AAA9H,8IAAA,6BAA6B,OAAA;AAAE,qJAAA,oCAAoC,OAAA;AAE5E,UAAU;AACV,0FAAyF;AAAhF,8HAAA,qBAAqB,OAAA;AAE9B,0DAS0C;AAFxC,yGAAA,gBAAgB,OAAA;AAChB,qGAAA,YAAY,OAAA;AAEd,qHAAoH;AAA3G,wJAAA,kCAAkC,OAAA;AAC3C,2EAA0E;AAAjE,8GAAA,aAAa,OAAA;AAEtB,2BAA2B;AAC3B,wDAsBiC;AArB/B,2GAAA,WAAW,OAAA;AACX,kHAAA,kBAAkB,OAAA;AAClB,kHAAA,kBAAkB,OAAA;AAClB,2HAAA,2BAA2B,OAAA;AAC3B,iHAAA,iBAAiB,OAAA;AACjB,oHAAA,oBAAoB,OAAA;AACpB,oHAAA,oBAAoB,OAAA;AACpB,qHAAA,qBAAqB,OAAA;AACrB,+HAAA,+BAA+B,OAAA;AAC/B,6GAAA,aAAa,OAAA;AACb,yGAAA,SAAS,OAAA;AACT,mHAAA,mBAAmB,OAAA;AACnB,8GAAA,cAAc,OAAA;AACd,6GAAA,aAAa,OAAA;AACb,4GAAA,YAAY,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":";AAAA,iCAAiC;;;;;;;;;;;;;;;;;;;AAEjC,QAAQ;AACR,0CAAwB;AACxB,yDAAuC;AACvC,uDAAqC;AAErC,6EAA6E;AAC7E,+EAA+E;AAC/E,iDAAiD;AACjD,qEAAqE;AACrE,+CAgE+B;AA/D7B,4GAAA,mBAAmB,OAAA;AACnB,kHAAA,yBAAyB,OAAA;AACzB,gHAAA,uBAAuB,OAAA;AACvB,mGAAA,UAAU,OAAA;AACV,gHAAA,uBAAuB,OAAA;AACvB,wGAAA,eAAe,OAAA;AACf,yGAAA,gBAAgB,OAAA;AAChB,qGAAA,YAAY,OAAA;AACZ,+GAAA,sBAAsB,OAAA;AACtB,6GAAA,oBAAoB,OAAA;AACpB,6GAAA,oBAAoB,OAAA;AACpB,gHAAA,uBAAuB,OAAA;AACvB,+GAAA,sBAAsB,OAAA;AACtB,gHAAA,uBAAuB,OAAA;AACvB,8GAAA,qBAAqB,OAAA;AACrB,oHAAA,2BAA2B,OAAA;AAC3B,uHAAA,8BAA8B,OAAA;AAC9B,gHAAA,uBAAuB,OAAA;AACvB,+GAAA,sBAAsB,OAAA;AACtB,gHAAA,uBAAuB,OAAA;AACvB,8GAAA,qBAAqB,OAAA;AACrB,oHAAA,2BAA2B,OAAA;AAC3B,gHAAA,uBAAuB,OAAA;AACvB,+GAAA,sBAAsB,OAAA;AACtB,gHAAA,uBAAuB,OAAA;AACvB,+GAAA,sBAAsB,OAAA;AACtB,gHAAA,uBAAuB,OAAA;AACvB,qHAAA,4BAA4B,OAAA;AAC5B,gHAAA,uBAAuB,OAAA;AACvB,+GAAA,sBAAsB,OAAA;AACtB,gHAAA,uBAAuB,OAAA;AACvB,+GAAA,sBAAsB,OAAA;AACtB,qHAAA,4BAA4B,OAAA;AAgC9B,yEAM4C;AAL1C,uHAAA,iBAAiB,OAAA;AACjB,kHAAA,YAAY,OAAA;AAKd,uEAAsE;AAA7D,sHAAA,iBAAiB,OAAA;AAK1B,eAAe;AACf,+CAA8C;AAArC,4GAAA,YAAY,OAAA;AACrB,uDAAsD;AAA7C,oHAAA,gBAAgB,OAAA;AACzB,qEAAoE;AAA3D,kIAAA,uBAAuB,OAAA;AAEhC,6DAO+B;AAN7B,0HAAA,mBAAmB,OAAA;AAUrB,wDAAuD;AAA9C,8GAAA,aAAa,OAAA;AACtB,4DAA2D;AAAlD,kHAAA,eAAe,OAAA;AACxB,4DAIkC;AAHhC,wHAAA,qBAAqB,OAAA;AACrB,yHAAA,sBAAsB,OAAA;AAIxB,OAAO;AACP,wCAAuD;AAA9C,gGAAA,MAAM,OAAA;AAEf,MAAM;AACN,6CAcyB;AAbvB,4GAAA,eAAe,OAAA;AACf,4GAAA,eAAe,OAAA;AACf,wGAAA,WAAW,OAAA;AACX,yHAAA,4BAA4B,OAAA;AAC5B,yHAAA,4BAA4B,OAAA;AAC5B,yHAAA,4BAA4B,OAAA;AAC5B,yHAAA,4BAA4B,OAAA;AAC5B,yHAAA,4BAA4B,OAAA;AAC5B,yHAAA,4BAA4B,OAAA;AAC5B,yHAAA,4BAA4B,OAAA;AAC5B,yHAAA,4BAA4B,OAAA;AAK9B,SAAS;AACT,mCAKkB;AAJhB,mHAAA,yBAAyB,OAAA;AACzB,+GAAA,qBAAqB,OAAA;AACrB,8GAAA,oBAAoB,OAAA;AACpB,gHAAA,sBAAsB,OAAA;AAKxB,2DAAkE;AAAzD,0HAAA,uBAAuB,OAAA;AAChC,6EAA4E;AAAnE,oIAAA,wBAAwB,OAAA;AACjC,qDAA+F;AAAtF,4GAAA,YAAY,OAAA;AAErB,YAAY;AACZ,iCAYiB;AAXf,2GAAA,kBAAkB,OAAA;AAClB,gHAAA,uBAAuB,OAAA;AACvB,kHAAA,yBAAyB,OAAA;AACzB,0GAAA,iBAAiB,OAAA;AACjB,2GAAA,kBAAkB,OAAA;AAClB,wGAAA,eAAe,OAAA;AACf,+GAAA,sBAAsB,OAAA;AACtB,qGAAA,YAAY,OAAA;AACZ,4GAAA,mBAAmB,OAAA;AACnB,gHAAA,uBAAuB,OAAA;AACvB,2GAAA,kBAAkB,OAAA;AAmBpB,kGAAuI;AAA9H,8IAAA,6BAA6B,OAAA;AAAE,qJAAA,oCAAoC,OAAA;AAE5E,UAAU;AACV,0FAAyF;AAAhF,8HAAA,qBAAqB,OAAA;AAE9B,0DAS0C;AAFxC,yGAAA,gBAAgB,OAAA;AAChB,qGAAA,YAAY,OAAA;AAEd,qHAAoH;AAA3G,wJAAA,kCAAkC,OAAA;AAC3C,2EAA0E;AAAjE,8GAAA,aAAa,OAAA;AAEtB,2BAA2B;AAC3B,wDAyBiC;AAxB/B,2GAAA,WAAW,OAAA;AACX,kHAAA,kBAAkB,OAAA;AAClB,kHAAA,kBAAkB,OAAA;AAClB,2HAAA,2BAA2B,OAAA;AAC3B,iHAAA,iBAAiB,OAAA;AACjB,oHAAA,oBAAoB,OAAA;AACpB,oHAAA,oBAAoB,OAAA;AACpB,qHAAA,qBAAqB,OAAA;AACrB,+HAAA,+BAA+B,OAAA;AAC/B,6GAAA,aAAa,OAAA;AACb,yGAAA,SAAS,OAAA;AACT,mHAAA,mBAAmB,OAAA;AACnB,8GAAA,cAAc,OAAA;AACd,6GAAA,aAAa,OAAA;AACb,4GAAA,YAAY,OAAA;AAYd,qEAAqE;AACrE,8CAA8C;AAC9C,4EAO2C;AANzC,gIAAA,sBAAsB,OAAA;AACtB,uIAAA,6BAA6B,OAAA;AAC7B,0IAAA,gCAAgC,OAAA;AAMlC,qEAAqE;AACrE,uDAAuD;AACvD,gDAA8B;AAE9B,uDAAuD;AACvD,iCAkBiB;AAjBf,qGAAA,YAAY,OAAA;AACZ,yGAAA,gBAAgB,OAAA;AAChB,yGAAA,gBAAgB,OAAA;AAChB,6GAAA,oBAAoB,OAAA;AACpB,mHAAA,0BAA0B,OAAA;AAC1B,wGAAA,eAAe,OAAA;AAcjB,8DAA8D;AAC9D,8CAmB4B;AAlB1B,+GAAA,oBAAoB,OAAA;AACpB,yHAAA,8BAA8B,OAAA;AAE9B,+GAAA,oBAAoB,OAAA;AACpB,0HAAA,+BAA+B,OAAA;AAC/B,gHAAA,qBAAqB,OAAA;AACrB,+GAAA,oBAAoB,OAAA;AACpB,+GAAA,oBAAoB,OAAA;AACpB,6GAAA,kBAAkB,OAAA;AAClB,0HAAA,+BAA+B,OAAA;AAC/B,0GAAA,eAAe,OAAA;AACf,8GAAA,mBAAmB,OAAA;AACnB,4GAAA,iBAAiB,OAAA;AAQnB,4EAA4E;AAC5E,gDAqB6B;AApB3B,iHAAA,qBAAqB,OAAA;AACrB,6GAAA,iBAAiB,OAAA;AACjB,2GAAA,eAAe,OAAA;AACf,iHAAA,qBAAqB,OAAA;AACrB,kHAAA,sBAAsB,OAAA;AACtB,4HAAA,gCAAgC,OAAA;AAChC,4GAAA,gBAAgB,OAAA;AAChB,iHAAA,qBAAqB,OAAA;AACrB,gHAAA,oBAAoB,OAAA;AACpB,qHAAA,yBAAyB,OAAA;AACzB,yHAAA,6BAA6B,OAAA;AAC7B,4HAAA,gCAAgC,OAAA;AAWlC,yEAAyE;AACzE,8EAA8E;AAC9E,4CAI4B;AAH1B,+GAAA,sBAAsB,OAAA;AACtB,iHAAA,wBAAwB,OAAA"}

package/dist/core/indexing/createViewDataProvider.d.ts

@@ -0,0 +1,84 @@
+import type { MindooDB } from "../types";
+import type { MindooDBAppBooleanExpression } from "../expressions/types";
+import type { IVirtualViewDataProvider } from "./virtualviews/IVirtualViewDataProvider";
+import { VirtualViewColumn, type VirtualViewColumnOptions } from "./virtualviews/VirtualViewColumn";
+import type { DocumentFilterFunction } from "./virtualviews/types";
+/**
+ * Options for {@link createViewDataProvider} — the summary-first data
+ * provider factory.
+ */
+export interface CreateViewDataProviderOptions {
+    /** Unique origin identifier for this data provider. */
+    origin: string;
+    /** The database feeding this provider. */
+    db: MindooDB;
+    /**
+     * The view's columns. Needed to decide whether the view can be served
+     * from the summary buffer (declarative `expression`/field columns) or
+     * requires materialized documents (JS `valueFunction` columns).
+     */
+    columns: Array<VirtualViewColumn | VirtualViewColumnOptions>;
+    /**
+     * Document filter: a declarative expression (summary-capable) or a JS
+     * function receiving the materialized document (forces the full-document
+     * path, since summary entries cannot be passed to it).
+     */
+    filter?: MindooDBAppBooleanExpression | DocumentFilterFunction;
+    /**
+     * Force this provider to materialize full documents instead of reading
+     * the summary buffer — the escape hatch for views that need data the
+     * summary cannot deliver (decrypted fields, uncovered fields) or that
+     * deliberately want per-document JS evaluation. Expensive by design,
+     * mirroring `allowFullScan` on `db.query()`.
+     */
+    useFullDocuments?: boolean;
+    /**
+     * Copy every (non-underscore) document field into the view entry.
+     * Implies the full-document path (see
+     * {@link MindooDBVirtualViewDataProvider}).
+     */
+    includeAllDocumentFields?: boolean;
+}
+/** Where a created view data provider reads its data from. */
+export type ViewDataProviderSource = "summary" | "documents";
+export interface CreateViewDataProviderResult {
+    provider: IVirtualViewDataProvider;
+    /** The path the factory chose. */
+    source: ViewDataProviderSource;
+    /**
+     * When `source` is `"documents"`, the reasons why the summary path was
+     * not usable (empty for an explicit `useFullDocuments` request). Useful
+     * for logging/diagnosing why a view runs on the slow path.
+     */
+    fallbackReasons: string[];
+}
+/**
+ * Create a VirtualView data provider for a database, preferring the
+ * document summary buffer for the best indexing performance. The summary
+ * path is chosen whenever the view definition can be answered from the
+ * summary; otherwise the factory transparently falls back to the
+ * materialized-document provider and reports why.
+ *
+ * The full-document path is used when any of these hold:
+ * - `useFullDocuments: true` (explicit request) or `includeAllDocumentFields`,
+ * - the filter is a JS function or a column uses a JS `valueFunction`,
+ * - an expression needs decryption or a view-tree context,
+ * - a referenced field is not covered by the database's summary
+ *   configuration (see the `dbsetup` design document).
+ *
+ * Async because the summary configuration may live in the synced `dbsetup`
+ * document and has to be loaded before coverage can be decided.
+ */
+export declare function createViewDataProvider(options: CreateViewDataProviderOptions): Promise<CreateViewDataProviderResult>;
+/**
+ * Why a view definition cannot be served from the summary buffer (empty
+ * array = summary-capable). Exposed for consumers (e.g. Haven) that want
+ * to surface the decision in a UI.
+ */
+export declare function collectSummaryFallbackReasons(options: Pick<CreateViewDataProviderOptions, "db" | "columns" | "filter" | "includeAllDocumentFields">): Promise<string[]>;
+/**
+ * Wrap a declarative filter expression into a DocumentFilterFunction for
+ * the full-document path, so the same view definition works on both paths.
+ */
+export declare function filterExpressionToDocumentFilter(filter: MindooDBAppBooleanExpression | undefined): DocumentFilterFunction | undefined;
+//# sourceMappingURL=createViewDataProvider.d.ts.map

package/dist/core/indexing/createViewDataProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createViewDataProvider.d.ts","sourceRoot":"","sources":["../../../src/core/indexing/createViewDataProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,sBAAsB,CAAC;AAGzE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,yCAAyC,CAAC;AAExF,OAAO,EAAE,iBAAiB,EAAE,KAAK,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AACpG,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAGnE;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC;IAEf,0CAA0C;IAC1C,EAAE,EAAE,QAAQ,CAAC;IAEb;;;;OAIG;IACH,OAAO,EAAE,KAAK,CAAC,iBAAiB,GAAG,wBAAwB,CAAC,CAAC;IAE7D;;;;OAIG;IACH,MAAM,CAAC,EAAE,4BAA4B,GAAG,sBAAsB,CAAC;IAE/D;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC;AAED,8DAA8D;AAC9D,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,WAAW,CAAC;AAE7D,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,EAAE,wBAAwB,CAAC;IACnC,kCAAkC;IAClC,MAAM,EAAE,sBAAsB,CAAC;IAC/B;;;;OAIG;IACH,eAAe,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,4BAA4B,CAAC,CAiCvC;AAED;;;;GAIG;AACH,wBAAsB,6BAA6B,CACjD,OAAO,EAAE,IAAI,CAAC,6BAA6B,EAAE,IAAI,GAAG,SAAS,GAAG,QAAQ,GAAG,0BAA0B,CAAC,GACrG,OAAO,CAAC,MAAM,EAAE,CAAC,CAyEnB;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,CAC9C,MAAM,EAAE,4BAA4B,GAAG,SAAS,GAC/C,sBAAsB,GAAG,SAAS,CAepC"}

package/dist/core/indexing/createViewDataProvider.js

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createViewDataProvider = createViewDataProvider;
+exports.collectSummaryFallbackReasons = collectSummaryFallbackReasons;
+exports.filterExpressionToDocumentFilter = filterExpressionToDocumentFilter;
+const expressions_1 = require("../expressions");
+const evaluateExpression_1 = require("../expressions/evaluateExpression");
+const MindooDBVirtualViewDataProvider_1 = require("./virtualviews/MindooDBVirtualViewDataProvider");
+const VirtualViewColumn_1 = require("./virtualviews/VirtualViewColumn");
+const SummaryVirtualViewDataProvider_1 = require("./summary/SummaryVirtualViewDataProvider");
+/**
+ * Create a VirtualView data provider for a database, preferring the
+ * document summary buffer for the best indexing performance. The summary
+ * path is chosen whenever the view definition can be answered from the
+ * summary; otherwise the factory transparently falls back to the
+ * materialized-document provider and reports why.
+ *
+ * The full-document path is used when any of these hold:
+ * - `useFullDocuments: true` (explicit request) or `includeAllDocumentFields`,
+ * - the filter is a JS function or a column uses a JS `valueFunction`,
+ * - an expression needs decryption or a view-tree context,
+ * - a referenced field is not covered by the database's summary
+ *   configuration (see the `dbsetup` design document).
+ *
+ * Async because the summary configuration may live in the synced `dbsetup`
+ * document and has to be loaded before coverage can be decided.
+ */
+async function createViewDataProvider(options) {
+    const { origin, db, filter } = options;
+    const buildDocumentProvider = (fallbackReasons) => ({
+        provider: new MindooDBVirtualViewDataProvider_1.MindooDBVirtualViewDataProvider({
+            origin,
+            db,
+            filterFunction: typeof filter === "function" ? filter : filterExpressionToDocumentFilter(filter),
+            includeAllDocumentFields: options.includeAllDocumentFields,
+        }),
+        source: "documents",
+        fallbackReasons,
+    });
+    if (options.useFullDocuments) {
+        return buildDocumentProvider([]);
+    }
+    const reasons = await collectSummaryFallbackReasons(options);
+    if (reasons.length > 0) {
+        return buildDocumentProvider(reasons);
+    }
+    return {
+        provider: new SummaryVirtualViewDataProvider_1.SummaryVirtualViewDataProvider({
+            origin,
+            summary: db.getSummaryStore(),
+            filter: filter,
+        }),
+        source: "summary",
+        fallbackReasons: [],
+    };
+}
+/**
+ * Why a view definition cannot be served from the summary buffer (empty
+ * array = summary-capable). Exposed for consumers (e.g. Haven) that want
+ * to surface the decision in a UI.
+ */
+async function collectSummaryFallbackReasons(options) {
+    const reasons = [];
+    const { db, filter } = options;
+    if (options.includeAllDocumentFields) {
+        reasons.push("includeAllDocumentFields copies whole documents into view entries");
+    }
+    if (!db.getSummaryStore) {
+        reasons.push("the database does not support summary stores");
+        return reasons;
+    }
+    if (typeof filter === "function") {
+        reasons.push("the filter is a JS function that needs the materialized document");
+    }
+    const referencedPaths = new Set();
+    for (const column of options.columns) {
+        const resolved = column instanceof VirtualViewColumn_1.VirtualViewColumn ? column : new VirtualViewColumn_1.VirtualViewColumn(column);
+        if (resolved.valueFunction && !resolved.expression) {
+            reasons.push(`column '${resolved.name}' uses a JS valueFunction that needs the materialized document`);
+            continue;
+        }
+        if (resolved.expression) {
+            const requirements = (0, expressions_1.analyzeExpressionRequirements)(resolved.expression);
+            if (requirements.needsDecryption) {
+                reasons.push(`column '${resolved.name}' uses decrypt expressions; encrypted fields are not stored in the summary buffer`);
+            }
+            if (requirements.needsViewContext) {
+                reasons.push(`column '${resolved.name}' uses view-tree operations (${requirements.viewContextOperations.join(", ")})`);
+            }
+            for (const path of (0, expressions_1.getReferencedFields)(resolved.expression)) {
+                referencedPaths.add(path);
+            }
+        }
+        else {
+            // Plain columns read the summary field of the same name.
+            referencedPaths.add(resolved.name);
+        }
+    }
+    if (filter && typeof filter !== "function") {
+        const requirements = (0, expressions_1.analyzeExpressionRequirements)(filter);
+        if (requirements.needsDecryption) {
+            reasons.push("the filter uses decrypt expressions; encrypted fields are not stored in the summary buffer");
+        }
+        if (requirements.needsViewContext) {
+            reasons.push(`the filter uses view-tree operations (${requirements.viewContextOperations.join(", ")})`);
+        }
+        for (const path of (0, expressions_1.getReferencedFields)(filter)) {
+            referencedPaths.add(path);
+        }
+    }
+    // Coverage is decided against the settled configuration (which may come
+    // from the synced dbsetup document).
+    const summary = db.getSummaryStore();
+    await summary.ensureConfigLoaded();
+    for (const path of referencedPaths) {
+        if (!summary.isFieldCovered(path)) {
+            reasons.push(`field "${path}" is not covered by the summary configuration`);
+        }
+    }
+    return reasons;
+}
+/**
+ * Wrap a declarative filter expression into a DocumentFilterFunction for
+ * the full-document path, so the same view definition works on both paths.
+ */
+function filterExpressionToDocumentFilter(filter) {
+    if (!filter) {
+        return undefined;
+    }
+    return (doc) => (0, evaluateExpression_1.expressionToBoolean)((0, evaluateExpression_1.evaluateExpression)(filter, {
+        doc: doc.getData(),
+        values: {},
+        origin: "",
+        createdAt: new Date(doc.getCreatedAt()).toISOString(),
+        decryptionKeyId: doc.getDecryptionKeyId(),
+        variables: {},
+    }));
+}
+//# sourceMappingURL=createViewDataProvider.js.map

package/dist/core/indexing/createViewDataProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createViewDataProvider.js","sourceRoot":"","sources":["../../../src/core/indexing/createViewDataProvider.ts"],"names":[],"mappings":";;AAoFA,wDAmCC;AAOD,sEA2EC;AAMD,4EAiBC;AA9ND,gDAAoF;AACpF,0EAA4F;AAE5F,oGAAiG;AACjG,wEAAoG;AAEpG,6FAA0F;AA2D1F;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,sBAAsB,CAC1C,OAAsC;IAEtC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAEvC,MAAM,qBAAqB,GAAG,CAAC,eAAyB,EAAgC,EAAE,CAAC,CAAC;QAC1F,QAAQ,EAAE,IAAI,iEAA+B,CAAC;YAC5C,MAAM;YACN,EAAE;YACF,cAAc,EACZ,OAAO,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,gCAAgC,CAAC,MAAM,CAAC;YAClF,wBAAwB,EAAE,OAAO,CAAC,wBAAwB;SAC3D,CAAC;QACF,MAAM,EAAE,WAAW;QACnB,eAAe;KAChB,CAAC,CAAC;IAEH,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC7B,OAAO,qBAAqB,CAAC,EAAE,CAAC,CAAC;IACnC,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,6BAA6B,CAAC,OAAO,CAAC,CAAC;IAC7D,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,OAAO,qBAAqB,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,OAAO;QACL,QAAQ,EAAE,IAAI,+DAA8B,CAAC;YAC3C,MAAM;YACN,OAAO,EAAE,EAAE,CAAC,eAAgB,EAAE;YAC9B,MAAM,EAAE,MAAkD;SAC3D,CAAC;QACF,MAAM,EAAE,SAAS;QACjB,eAAe,EAAE,EAAE;KACpB,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,6BAA6B,CACjD,OAAsG;IAEtG,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAE/B,IAAI,OAAO,CAAC,wBAAwB,EAAE,CAAC;QACrC,OAAO,CAAC,IAAI,CAAC,mEAAmE,CAAC,CAAC;IACpF,CAAC;IACD,IAAI,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC;QACxB,OAAO,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;QAC7D,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;QACjC,OAAO,CAAC,IAAI,CAAC,kEAAkE,CAAC,CAAC;IACnF,CAAC;IAED,MAAM,eAAe,GAAG,IAAI,GAAG,EAAU,CAAC;IAE1C,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACrC,MAAM,QAAQ,GAAG,MAAM,YAAY,qCAAiB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,qCAAiB,CAAC,MAAM,CAAC,CAAC;QAC9F,IAAI,QAAQ,CAAC,aAAa,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;YACnD,OAAO,CAAC,IAAI,CACV,WAAW,QAAQ,CAAC,IAAI,gEAAgE,CACzF,CAAC;YACF,SAAS;QACX,CAAC;QACD,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;YACxB,MAAM,YAAY,GAAG,IAAA,2CAA6B,EAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YACxE,IAAI,YAAY,CAAC,eAAe,EAAE,CAAC;gBACjC,OAAO,CAAC,IAAI,CACV,WAAW,QAAQ,CAAC,IAAI,mFAAmF,CAC5G,CAAC;YACJ,CAAC;YACD,IAAI,YAAY,CAAC,gBAAgB,EAAE,CAAC;gBAClC,OAAO,CAAC,IAAI,CACV,WAAW,QAAQ,CAAC,IAAI,gCAAgC,YAAY,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACzG,CAAC;YACJ,CAAC;YACD,KAAK,MAAM,IAAI,IAAI,IAAA,iCAAmB,EAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC5D,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;aAAM,CAAC;YACN,yDAAyD;YACzD,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAED,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;QAC3C,MAAM,YAAY,GAAG,IAAA,2CAA6B,EAAC,MAAM,CAAC,CAAC;QAC3D,IAAI,YAAY,CAAC,eAAe,EAAE,CAAC;YACjC,OAAO,CAAC,IAAI,CAAC,4FAA4F,CAAC,CAAC;QAC7G,CAAC;QACD,IAAI,YAAY,CAAC,gBAAgB,EAAE,CAAC;YAClC,OAAO,CAAC,IAAI,CACV,yCAAyC,YAAY,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAC1F,CAAC;QACJ,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,IAAA,iCAAmB,EAAC,MAAM,CAAC,EAAE,CAAC;YAC/C,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,wEAAwE;IACxE,qCAAqC;IACrC,MAAM,OAAO,GAAG,EAAE,CAAC,eAAe,EAAE,CAAC;IACrC,MAAM,OAAO,CAAC,kBAAkB,EAAE,CAAC;IACnC,KAAK,MAAM,IAAI,IAAI,eAAe,EAAE,CAAC;QACnC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,OAAO,CAAC,IAAI,CAAC,UAAU,IAAI,+CAA+C,CAAC,CAAC;QAC9E,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,SAAgB,gCAAgC,CAC9C,MAAgD;IAEhD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,CAAC,GAAG,EAAE,EAAE,CACb,IAAA,wCAAmB,EACjB,IAAA,uCAAkB,EAAC,MAAM,EAAE;QACzB,GAAG,EAAE,GAAG,CAAC,OAAO,EAA6B;QAC7C,MAAM,EAAE,EAAE;QACV,MAAM,EAAE,EAAE;QACV,SAAS,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,WAAW,EAAE;QACrD,eAAe,EAAE,GAAG,CAAC,kBAAkB,EAAE;QACzC,SAAS,EAAE,EAAE;KACd,CAAC,CACH,CAAC;AACN,CAAC"}