mindoodb 0.0.3 → 0.0.5

package/README.md

@@ -11,6 +11,9 @@ Your data is encrypted on the client before it ever touches a server. No plainte
 
 > ⚠️ **Alpha software**: This project is in early development and not yet recommended for production use. APIs may change without notice.
 
+Use AI to explore this repository:
+
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/klehmann/MindooDB)
 
 ## The Problem
 
@@ -86,37 +89,22 @@ npm install mindoodb
 import { 
   BaseMindooTenantFactory, 
   InMemoryContentAddressedStoreFactory,
-  KeyBag,
-  PUBLIC_INFOS_KEY_ID
 } from "mindoodb";
 
 // 1. Set up storage (in-memory for demo; use file/server-backed for production)
 const storeFactory = new InMemoryContentAddressedStoreFactory();
 const factory = new BaseMindooTenantFactory(storeFactory);
 
-// 2. Create a user (generates signing + encryption key pairs)
-const user = await factory.createUserId("CN=alice/O=acme", "user-password");
-const keyBag = new KeyBag(user.userEncryptionKeyPair.privateKey, "user-password");
-
-// 3. Create admin user (signing + encryption keys used for tenant administration)
-const adminUser = await factory.createUserId("CN=admin/O=acme", "admin-password");
-
-// 4. Create required tenant keys directly in KeyBag (canonical key source)
-const tenantId = "acme-corp";
-await keyBag.createTenantKey(tenantId);
-await keyBag.createDocKey(PUBLIC_INFOS_KEY_ID);
-
-// 5. Open tenant
-const tenant = await factory.openTenant(
-  tenantId,
-  adminUser.userSigningKeyPair.publicKey,
-  adminUser.userEncryptionKeyPair.publicKey,
-  user,
-  "user-password",
-  keyBag
-);
-
-// 6. Open a database and create documents
+// 2. Create tenant (generates all keys, opens tenant, registers user — single call)
+const { tenant, adminUser, appUser, keyBag } = await factory.createTenant({
+  tenantId: "acme-corp",
+  adminName: "cn=admin/o=acme",
+  adminPassword: "admin-password",
+  userName: "cn=alice/o=acme",
+  userPassword: "user-password",
+});
+
+// 3. Open a database and create documents
 const db = await tenant.openDB("contacts");
 const doc = await db.createDocument();
 
@@ -126,7 +114,7 @@ await db.changeDoc(doc, async (d) => {
   data.email = "john@example.com";
 });
 
-// 7. Read it back
+// 4. Read it back
 const contacts = await db.getAllDocumentIds();
 const loaded = await db.getDocument(contacts[0]);
 console.log(loaded.getData()); // { name: "John Doe", email: "john@example.com" }

package/dist/appendonlystores/network/ClientNetworkContentAddressedStore.d.ts

@@ -1,5 +1,6 @@
 import type { ContentAddressedStore } from "../../core/types";
 import type { StoreEntry, StoreEntryMetadata, StoreEntryType, StoreScanCursor, StoreScanFilters, StoreScanResult, StoreIdBloomSummary, StoreCompactionStatus } from "../../core/types";
+import type { AttachmentReadPlan, AttachmentReadPlanOptions, DocumentMaterializationBatchPlan, DocumentMaterializationPlan, MaterializationPlanOptions } from "../../core/appendonlystores/types";
 import type { CryptoAdapter } from "../../core/crypto/CryptoAdapter";
 import type { NetworkTransport } from "../../core/appendonlystores/network/NetworkTransport";
 import type { NetworkSyncCapabilities } from "../../core/appendonlystores/network/types";
@@ -28,8 +29,10 @@ export declare class ClientNetworkContentAddressedStore implements ContentAddres
     private cryptoAdapter;
     private accessToken;
     private tokenExpiry;
+    private authenticationPromise;
     private logger;
     private capabilitiesCache;
+    private syncAuthOverride;
     /**
      * Create a new ClientNetworkContentAddressedStore.
      *
@@ -43,6 +46,7 @@ export declare class ClientNetworkContentAddressedStore implements ContentAddres
      */
     constructor(dbId: string, transport: NetworkTransport, cryptoAdapter: CryptoAdapter, username: string, signingKey: CryptoKey, privateEncryptionKey: CryptoKey | string, logger?: Logger);
     getId(): string;
+    getCacheIdentity(): string;
     /**
      * Store entries to the remote store.
      * The entries are pushed to the server immediately.
@@ -55,6 +59,8 @@ export declare class ClientNetworkContentAddressedStore implements ContentAddres
      * @returns The entries with decrypted payloads
      */
     getEntries(ids: string[]): Promise<StoreEntry[]>;
+    getEntryMetadata(id: string): Promise<StoreEntryMetadata | null>;
+    planAttachmentReadByWalkingMetadata(lastChunkId: string, attachmentSize: number, options: AttachmentReadPlanOptions): Promise<AttachmentReadPlan>;
     /**
      * Check which IDs exist in the remote store.
      *
@@ -77,6 +83,7 @@ export declare class ClientNetworkContentAddressedStore implements ContentAddres
      * Find entries by type and creation date range from the remote store.
      */
     findEntries(type: StoreEntryType, creationDateFrom: number | null, creationDateUntil: number | null): Promise<StoreEntryMetadata[]>;
+    private supportsReceiptOrderCursorProtocol;
     /**
      * Get all entry IDs from the remote store.
      * Used for synchronization to identify which entries the remote has.
@@ -90,6 +97,8 @@ export declare class ClientNetworkContentAddressedStore implements ContentAddres
     getIdBloomSummary(): Promise<StoreIdBloomSummary>;
     getCapabilities(): Promise<NetworkSyncCapabilities>;
     getCompactionStatus(): Promise<StoreCompactionStatus>;
+    planDocumentMaterialization(docId: string, options?: MaterializationPlanOptions): Promise<DocumentMaterializationPlan>;
+    planDocumentMaterializationBatch(docIds: string[], options?: MaterializationPlanOptions): Promise<DocumentMaterializationBatchPlan>;
     /**
      * Resolve dependencies for an entry.
      *
@@ -110,10 +119,12 @@ export declare class ClientNetworkContentAddressedStore implements ContentAddres
      * Ensure we have a valid access token, authenticating if necessary.
      */
     private ensureAuthenticated;
+    private performAuthentication;
     /**
      * Sign a challenge with the user's private signing key.
      */
     private signChallenge;
+    private signChallengeWithKey;
     /**
      * Decrypt network-encrypted entries.
      * Transforms NetworkEncryptedEntry[] to StoreEntry[].
@@ -124,5 +135,21 @@ export declare class ClientNetworkContentAddressedStore implements ContentAddres
      * Call this if you need to force re-authentication.
      */
     clearAuthCache(): void;
+    private refreshAuthentication;
+    private isInvalidTokenError;
+    private withTransparentReauth;
+    /**
+     * Set or clear a temporary per-sync authentication override.
+     * Intended for bootstrap scenarios (for example authenticating as admin).
+     */
+    setSyncAuthOverride(override: {
+        username: string;
+        signingKey: CryptoKey;
+        privateEncryptionKey?: CryptoKey | string;
+    } | null): void;
+    clearSyncAuthOverride(): void;
+    private getActiveAuthUsername;
+    private getActiveSigningKey;
+    private getActivePrivateEncryptionKey;
 }
 //# sourceMappingURL=ClientNetworkContentAddressedStore.d.ts.map

package/dist/appendonlystores/network/ClientNetworkContentAddressedStore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ClientNetworkContentAddressedStore.d.ts","sourceRoot":"","sources":["../../../src/appendonlystores/network/ClientNetworkContentAddressedStore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,UAAU,EACV,kBAAkB,EAClB,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sDAAsD,CAAC;AAC7F,OAAO,KAAK,EAEV,uBAAuB,EACxB,MAAM,2CAA2C,CAAC;AAGnD,OAAO,EAAE,MAAM,EAAoC,MAAM,oBAAoB,CAAC;AAG9E;;;;;;;;;;;;;GAaG;AACH,qBAAa,kCAAmC,YAAW,qBAAqB;IAC9E,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,SAAS,CAAmB;IACpC,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,oBAAoB,CAAqB;IACjD,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,UAAU,CAAY;IAC9B,OAAO,CAAC,aAAa,CAAgB;IAGrC,OAAO,CAAC,WAAW,CAAuB;IAC1C,OAAO,CAAC,WAAW,CAAa;IAChC,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,iBAAiB,CAAwC;IAEjE;;;;;;;;;;OAUG;gBAED,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,gBAAgB,EAC3B,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,SAAS,EACrB,oBAAoB,EAAE,SAAS,GAAG,MAAM,EACxC,MAAM,CAAC,EAAE,MAAM;IAejB,KAAK,IAAI,MAAM;IAIf;;;OAGG;IACG,UAAU,CAAC,OAAO,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAatD;;;;;OAKG;IACG,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAmBtD;;;;;OAKG;IACG,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAclD;;;;;OAKG;IACG,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAWvE;;OAEG;IACG,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAU5F;;OAEG;IACG,WAAW,CACf,IAAI,EAAE,cAAc,EACpB,gBAAgB,EAAE,MAAM,GAAG,IAAI,EAC/B,iBAAiB,EAAE,MAAM,GAAG,IAAI,GAC/B,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAehC;;;OAGG;IACG,SAAS,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAUpC;;;OAGG;IACG,gBAAgB,CACpB,MAAM,EAAE,eAAe,GAAG,IAAI,EAC9B,KAAK,GAAE,MAAgC,EACvC,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,eAAe,CAAC;IA6CrB,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAYjD,eAAe,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAkBnD,mBAAmB,IAAI,OAAO,CAAC,qBAAqB,CAAC;IAsB3D;;;;OAIG;IACG,mBAAmB,CACvB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC,MAAM,EAAE,CAAC;IAUpB;;;;;;;;OAQG;IACG,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKnD;;OAEG;YACW,mBAAmB;IA8CjC;;OAEG;YACW,aAAa;IAa3B;;;OAGG;YACW,qBAAqB;IAkCnC;;;OAGG;IACH,cAAc,IAAI,IAAI;CAKvB"}
+{"version":3,"file":"ClientNetworkContentAddressedStore.d.ts","sourceRoot":"","sources":["../../../src/appendonlystores/network/ClientNetworkContentAddressedStore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,UAAU,EACV,kBAAkB,EAClB,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EACV,kBAAkB,EAClB,yBAAyB,EACzB,gCAAgC,EAChC,2BAA2B,EAC3B,0BAA0B,EAC3B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sDAAsD,CAAC;AAC7F,OAAO,KAAK,EAEV,uBAAuB,EACxB,MAAM,2CAA2C,CAAC;AAGnD,OAAO,EAAE,MAAM,EAAoC,MAAM,oBAAoB,CAAC;AAG9E;;;;;;;;;;;;;GAaG;AACH,qBAAa,kCAAmC,YAAW,qBAAqB;IAC9E,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,SAAS,CAAmB;IACpC,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,oBAAoB,CAAqB;IACjD,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,UAAU,CAAY;IAC9B,OAAO,CAAC,aAAa,CAAgB;IAGrC,OAAO,CAAC,WAAW,CAAuB;IAC1C,OAAO,CAAC,WAAW,CAAa;IAChC,OAAO,CAAC,qBAAqB,CAAgC;IAC7D,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,iBAAiB,CAAwC;IACjE,OAAO,CAAC,gBAAgB,CAIR;IAEhB;;;;;;;;;;OAUG;gBAED,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,gBAAgB,EAC3B,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,SAAS,EACrB,oBAAoB,EAAE,SAAS,GAAG,MAAM,EACxC,MAAM,CAAC,EAAE,MAAM;IAejB,KAAK,IAAI,MAAM;IAIf,gBAAgB,IAAI,MAAM;IAK1B;;;OAGG;IACG,UAAU,CAAC,OAAO,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAatD;;;;;OAKG;IACG,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAmBhD,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAQhE,mCAAmC,CACvC,WAAW,EAAE,MAAM,EACnB,cAAc,EAAE,MAAM,EACtB,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,kBAAkB,CAAC;IAW9B;;;;;OAKG;IACG,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAclD;;;;;OAKG;IACG,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAYvE;;OAEG;IACG,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAW5F;;OAEG;IACG,WAAW,CACf,IAAI,EAAE,cAAc,EACpB,gBAAgB,EAAE,MAAM,GAAG,IAAI,EAC/B,iBAAiB,EAAE,MAAM,GAAG,IAAI,GAC/B,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAgBhC,OAAO,CAAC,kCAAkC;IAQ1C;;;OAGG;IACG,SAAS,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAWpC;;;OAGG;IACG,gBAAgB,CACpB,MAAM,EAAE,eAAe,GAAG,IAAI,EAC9B,KAAK,GAAE,MAAgC,EACvC,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,eAAe,CAAC;IA4DrB,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAcjD,eAAe,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAuBnD,mBAAmB,IAAI,OAAO,CAAC,qBAAqB,CAAC;IAwBrD,2BAA2B,CAC/B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,2BAA2B,CAAC;IAWjC,gCAAgC,CACpC,MAAM,EAAE,MAAM,EAAE,EAChB,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,gCAAgC,CAAC;IAW5C;;;;OAIG;IACG,mBAAmB,CACvB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC,MAAM,EAAE,CAAC;IAYpB;;;;;;;;OAQG;IACG,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKnD;;OAEG;YACW,mBAAmB;YAsBnB,qBAAqB;IAyCnC;;OAEG;YACW,aAAa;YAIb,oBAAoB;IAalC;;;OAGG;YACW,qBAAqB;IAoCnC;;;OAGG;IACH,cAAc,IAAI,IAAI;YAMR,qBAAqB;IAKnC,OAAO,CAAC,mBAAmB;YAIb,qBAAqB;IAiBnC;;;OAGG;IACH,mBAAmB,CACjB,QAAQ,EAAE;QACR,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,SAAS,CAAC;QACtB,oBAAoB,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;KAC3C,GAAG,IAAI,GACP,IAAI;IAMP,qBAAqB,IAAI,IAAI;IAO7B,OAAO,CAAC,qBAAqB;IAI7B,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,6BAA6B;CAGtC"}