@peers-app/peers-sdk 0.25.8 → 0.25.10

package/dist/contracts/system/local-folders-contract.js

@@ -0,0 +1,235 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.localFoldersProviderPackageId = exports.LOCAL_FOLDERS_JOB_TTL_MS = exports.LOCAL_FOLDERS_RESERVED_DIR = exports.LOCAL_FOLDERS_CHUNK_MAX = exports.LOCAL_FOLDERS_CHUNK_AVG = exports.LOCAL_FOLDERS_CHUNK_MIN = exports.LOCAL_FOLDERS_READ_RANGE_MAX = exports.LOCAL_FOLDERS_CONTRACT_VERSION = void 0;
+exports.getLocalFoldersContractDefinition = getLocalFoldersContractDefinition;
+const system_ids_1 = require("../../system-ids");
+const field_type_1 = require("../../types/field-type");
+const system_contracts_1 = require("../system-contracts");
+/** Version of the built-in System Local Folders contract. */
+exports.LOCAL_FOLDERS_CONTRACT_VERSION = 1;
+/** Maximum byte length accepted by `readRange` in one call. */
+exports.LOCAL_FOLDERS_READ_RANGE_MAX = 256 * 1024;
+/** FastCDC minimum block size. Files at or below this size are one block. */
+exports.LOCAL_FOLDERS_CHUNK_MIN = 256 * 1024;
+/** FastCDC target average block size. */
+exports.LOCAL_FOLDERS_CHUNK_AVG = 1024 * 1024;
+/** FastCDC maximum block size. */
+exports.LOCAL_FOLDERS_CHUNK_MAX = 4 * 1024 * 1024;
+/** Directory name reserved inside every grant for trash and in-flight files. */
+exports.LOCAL_FOLDERS_RESERVED_DIR = ".peers";
+/** How long finished index jobs stay readable via `getJob`. */
+exports.LOCAL_FOLDERS_JOB_TTL_MS = 60 * 60 * 1000;
+/** Package ID used by live System Local Folders tool instances. */
+exports.localFoldersProviderPackageId = system_ids_1.peersSystemPackageId;
+const field = (name, type, description, opts = {}) => ({ name, type, description, ...opts });
+const grantIdField = field("grantId", field_type_1.FieldType.id, "Folder grant id.");
+let definition;
+/**
+ * Return the local-only System Local Folders contract shape.
+ *
+ * The host checks every path against an operator grant. Remote devices cannot call
+ * this contract; bytes between devices move through block exchange, not these tools.
+ */
+function getLocalFoldersContractDefinition() {
+    definition ??= {
+        contractId: system_ids_1.localFoldersContractId,
+        version: exports.LOCAL_FOLDERS_CONTRACT_VERSION,
+        devTag: "dev",
+        name: "System Local Folders",
+        description: "Scoped access to operator-granted folders on this device: listing, bounded reads, indexing, move, and trash.",
+        tables: [],
+        tools: [
+            {
+                name: "requestGrant",
+                usageDescription: "Grant a local folder. Omit absolutePath on desktop to open the folder picker. Isolated packages cannot create grants.",
+                inputFields: [
+                    field("groupId", field_type_1.FieldType.id, "Group this folder is associated with."),
+                    field("mode", field_type_1.FieldType.string, 'Either "read" or "readwrite".'),
+                    field("packageId", field_type_1.FieldType.id, "Package allowed to use the grant.", {
+                        optional: true,
+                    }),
+                    field("absolutePath", field_type_1.FieldType.string, "Absolute directory path. Operator callers only. Omit to open the picker.", { optional: true }),
+                ],
+                outputFields: [
+                    grantIdField,
+                    field("groupId", field_type_1.FieldType.id, "Group id stored on the grant."),
+                    field("absolutePath", field_type_1.FieldType.string, "Absolute path of the granted root."),
+                    field("mode", field_type_1.FieldType.string, "Grant mode."),
+                    field("packageId", field_type_1.FieldType.id, "Package the grant is scoped to.", { optional: true }),
+                    field("createdAt", field_type_1.FieldType.number, "Creation time in unix epoch milliseconds."),
+                ],
+            },
+            {
+                name: "listGrants",
+                usageDescription: "List active grants. Isolated callers see only grants scoped to their package.",
+                inputFields: [],
+                outputFields: [
+                    field("grants", field_type_1.FieldType.object, "Active grants on this device.", { isArray: true }),
+                ],
+            },
+            {
+                name: "revokeGrant",
+                usageDescription: "Revoke a grant. Access stops immediately. Isolated callers can revoke only their own grants.",
+                inputFields: [grantIdField],
+                outputFields: [field("revoked", field_type_1.FieldType.boolean, "Whether the grant is now revoked.")],
+            },
+            {
+                name: "list",
+                usageDescription: "List entries under a relative path inside a grant. Skips .peers.",
+                inputFields: [
+                    grantIdField,
+                    field("relPath", field_type_1.FieldType.string, "Relative directory. Empty lists the root.", {
+                        optional: true,
+                    }),
+                    field("recursive", field_type_1.FieldType.boolean, "List the subtree.", { optional: true }),
+                ],
+                outputFields: [field("entries", field_type_1.FieldType.object, "Directory entries.", { isArray: true })],
+            },
+            {
+                name: "stat",
+                usageDescription: "Stat one relative path inside a grant.",
+                inputFields: [
+                    grantIdField,
+                    field("relPath", field_type_1.FieldType.string, "Relative path inside the grant."),
+                ],
+                outputFields: [
+                    field("relPath", field_type_1.FieldType.string, "Relative path."),
+                    field("name", field_type_1.FieldType.string, "Final path segment."),
+                    field("kind", field_type_1.FieldType.string, "file, dir, or symlink."),
+                    field("size", field_type_1.FieldType.number, "Size in bytes."),
+                    field("mtimeMs", field_type_1.FieldType.number, "mtime in unix epoch milliseconds."),
+                    field("inode", field_type_1.FieldType.string, "File identity string."),
+                ],
+            },
+            {
+                name: "readRange",
+                usageDescription: `Read up to ${exports.LOCAL_FOLDERS_READ_RANGE_MAX} bytes at an offset. Returns base64.`,
+                inputFields: [
+                    grantIdField,
+                    field("relPath", field_type_1.FieldType.string, "Relative file path."),
+                    field("offset", field_type_1.FieldType.number, "Byte offset."),
+                    field("length", field_type_1.FieldType.number, "Requested length, capped by the host."),
+                ],
+                outputFields: [
+                    field("dataBase64", field_type_1.FieldType.string, "File bytes encoded as base64."),
+                    field("bytesRead", field_type_1.FieldType.number, "Number of bytes read."),
+                ],
+            },
+            {
+                name: "index",
+                usageDescription: "Start a host job that content-defines and hashes files into the local block index. Requires a readwrite grant.",
+                inputFields: [
+                    grantIdField,
+                    field("relPath", field_type_1.FieldType.string, "Relative file or directory. Empty indexes the grant.", {
+                        optional: true,
+                    }),
+                ],
+                outputFields: [field("jobId", field_type_1.FieldType.id, "Index job id.")],
+            },
+            {
+                name: "getFileBlocks",
+                usageDescription: "Return the indexed content-defined blocks for one file. Read mode is enough. indexed is false when the file has not been indexed.",
+                inputFields: [
+                    grantIdField,
+                    field("relPath", field_type_1.FieldType.string, "Relative file path inside the grant."),
+                ],
+                outputFields: [
+                    field("indexed", field_type_1.FieldType.boolean, "Whether an index row exists for this path."),
+                    field("size", field_type_1.FieldType.number, "File size in bytes at index time.", { optional: true }),
+                    field("mtimeMs", field_type_1.FieldType.number, "mtime in unix epoch milliseconds.", {
+                        optional: true,
+                    }),
+                    field("blocks", field_type_1.FieldType.object, "Ordered blocks with hash and size.", {
+                        isArray: true,
+                    }),
+                ],
+            },
+            {
+                name: "getJob",
+                usageDescription: "Return the status of an index job, including after it finishes.",
+                inputFields: [field("jobId", field_type_1.FieldType.id, "Job id returned by index.")],
+                outputFields: [
+                    field("jobId", field_type_1.FieldType.id, "Job id."),
+                    field("kind", field_type_1.FieldType.string, "Job kind. v1 is index."),
+                    field("status", field_type_1.FieldType.string, "running, done, error, or cancelled."),
+                    field("done", field_type_1.FieldType.number, "Units completed."),
+                    field("total", field_type_1.FieldType.number, "Units discovered."),
+                    field("error", field_type_1.FieldType.string, "Failure message.", { optional: true }),
+                    field("result", field_type_1.FieldType.object, "Index counts when status is done.", {
+                        optional: true,
+                    }),
+                ],
+            },
+            {
+                name: "cancelJob",
+                usageDescription: "Cancel a running index job.",
+                inputFields: [field("jobId", field_type_1.FieldType.id, "Job id returned by index.")],
+                outputFields: [field("cancelled", field_type_1.FieldType.boolean, "Whether the job was cancelled.")],
+            },
+            {
+                name: "move",
+                usageDescription: "Move a path inside a readwrite grant. Atomic where the OS allows.",
+                inputFields: [
+                    grantIdField,
+                    field("from", field_type_1.FieldType.string, "Relative source path."),
+                    field("to", field_type_1.FieldType.string, "Relative destination path."),
+                ],
+                outputFields: [field("moved", field_type_1.FieldType.boolean, "Whether the move completed.")],
+            },
+            {
+                name: "trash",
+                usageDescription: "Move a path to .peers/trash/<date>/ inside a readwrite grant.",
+                inputFields: [grantIdField, field("relPath", field_type_1.FieldType.string, "Relative path to trash.")],
+                outputFields: [
+                    field("trashed", field_type_1.FieldType.boolean, "Whether the path was moved to trash."),
+                    field("trashPath", field_type_1.FieldType.string, "Relative path inside the grant trash."),
+                ],
+            },
+            {
+                name: "purgeTrash",
+                usageDescription: "Delete trash entries older than the given number of days.",
+                inputFields: [
+                    grantIdField,
+                    field("olderThanDays", field_type_1.FieldType.number, "Delete trash dated strictly before this many days ago."),
+                ],
+                outputFields: [field("removed", field_type_1.FieldType.number, "Number of trash entries removed.")],
+            },
+        ],
+        observables: [],
+        events: [
+            {
+                name: "changed",
+                description: "Debounced filesystem changes inside a grant. The reserved .peers directory is omitted. v1 hosts emit created, modified, and deleted. renamed is reserved for a later host.",
+                payloadFields: [
+                    grantIdField,
+                    field("changes", field_type_1.FieldType.object, "Changes with relPath and kind. v1 hosts emit created, modified, or deleted. renamed is reserved.", { isArray: true }),
+                ],
+            },
+            {
+                name: "jobProgress",
+                description: "Progress for a host index job.",
+                payloadFields: [
+                    field("jobId", field_type_1.FieldType.id, "Job id."),
+                    field("done", field_type_1.FieldType.number, "Units completed."),
+                    field("total", field_type_1.FieldType.number, "Units discovered."),
+                ],
+            },
+            {
+                name: "jobFinished",
+                description: "An index job finished, failed, or was cancelled.",
+                payloadFields: [
+                    field("jobId", field_type_1.FieldType.id, "Job id."),
+                    field("status", field_type_1.FieldType.string, "done, error, or cancelled."),
+                    field("error", field_type_1.FieldType.string, "Failure message.", { optional: true }),
+                ],
+            },
+        ],
+    };
+    return definition;
+}
+(0, system_contracts_1.registerSystemContract)({
+    providerPackageId: system_ids_1.peersSystemPackageId,
+    contractId: system_ids_1.localFoldersContractId,
+    version: exports.LOCAL_FOLDERS_CONTRACT_VERSION,
+    getDefinition: getLocalFoldersContractDefinition,
+});

package/dist/contracts/system/network-contracts.d.ts

@@ -17,6 +17,7 @@ export declare const networkDiagnosticsToolIds: {
     readonly getGroupDetails: "00ms1yb50yuru8h1fg4t9na3e";
     readonly getDisconnectedDevices: "00ms1yb50y3jpoby5zomltahr";
     readonly queryRemoteLogs: "00ms1yb50y2fbfnth22yz52eu";
+    readonly getSyncRecoveryEntries: "00mujw2tgbpoohxvwd23u9moz";
 };
 /** Stable IDs for tools in System Network Control v1. */
 export declare const networkControlToolIds: {
@@ -26,6 +27,9 @@ export declare const networkControlToolIds: {
     readonly deleteDevice: "00ms1yb50y5mc448nuavlex86";
     readonly syncGroupNow: "00ms1yb50ylnqlra26jx232py";
     readonly resetChangeTracking: "00ms1yb50yfuackpl1w37hmxc";
+    readonly retrySyncRecovery: "00mujw2tgcelvpg556n836ah7";
+    readonly resolveSyncRecovery: "00mujw2tgciywn8krykc6gmwx";
+    readonly resetDeviceSyncInfo: "00mujw2tgc5lrezqrw4oneaot";
 };
 /** Overall status shown by the shell's compact network indicator. */
 export type NetworkStatusState = "offline" | "syncing" | "synced" | "error";
@@ -51,6 +55,11 @@ export interface INetworkStatusSummary {
     disconnectedContextCount: number;
     /** Sync contexts that currently have at least one live SyncGroup connection. */
     connectedContextCount: number;
+    /**
+     * Recovery-queue entries that are parked or have been retrying long enough
+     * that an operator should look at them. Zero means the indicator stays green.
+     */
+    stuckRecoveryCount: number;
     lastSuccessfulSyncAt?: number;
     errors: INetworkSyncError[];
 }
@@ -176,6 +185,56 @@ export interface INetworkControlResult {
     success: boolean;
     message: string;
 }
+/** How an operator resolves one stuck recovery-queue entry. */
+export type SyncRecoveryResolution = "keepLocal" | "deleteEverywhere" | "ignoreLocal";
+/** One recovery-queue entry prepared for the Sync Recovery screen. */
+export interface INetworkSyncRecoveryEntry {
+    dataContextId: string;
+    dataContextName: string;
+    syncRecoveryId: string;
+    tableName: string;
+    recordId: string;
+    firstFailedAt: number;
+    lastFailedAt: number;
+    attemptCount: number;
+    latestError: string;
+    status: "retrying" | "parked";
+    parkedReason?: "schema" | "unique-conflict" | "unresolvable";
+    stuck: boolean;
+    /** True when this device has a row that "Keep this device's version" can snapshot. */
+    localRowExists: boolean;
+    /** Other record id holding the same unique key, when the failure is a unique conflict. */
+    conflictingRecordId?: string;
+    /**
+     * Record id Keep will tombstone.
+     * The other stored row when both exist, or this queued id when only the other row is stored.
+     */
+    tombstoneRecordId?: string;
+    /**
+     * Short label taken from the row Keep will snapshot, or from queued history when nothing is stored.
+     */
+    recordSummary?: string;
+    /**
+     * Pretty-printed row Keep will snapshot, with secret values hidden.
+     * Dates and other special values use the change-history encoding (`__DATE`, and so on).
+     */
+    keptRecordPreview?: string;
+    /**
+     * Pretty-printed queued history when it differs from {@link keptRecordPreview}.
+     * Uses the same secret hiding and change-history encoding.
+     */
+    queuedRecordPreview?: string;
+    /**
+     * Pretty-printed stored record, with secret values hidden.
+     * Prefers the row Keep will snapshot, then queued history.
+     */
+    recordPreview?: string;
+    /**
+     * Author time of the change-tracking row that failed to materialize.
+     * Hybrid-logical-clock milliseconds. Omitted when no change row is stored.
+     */
+    changeCreatedAt?: number;
+}
 /** Typed consumer proxy for System Network Diagnostics v1. */
 export interface INetworkDiagnosticsConsumer extends IContractConsumerBase {
     tools: {
@@ -207,6 +266,11 @@ export interface INetworkDiagnosticsConsumer extends IContractConsumerBase {
             deviceId: string;
             query?: INetworkRemoteLogsQuery;
         }): Promise<INetworkRemoteLogsResult>;
+        getSyncRecoveryEntries(input?: {
+            dataContextId?: string;
+        }): Promise<{
+            entries: INetworkSyncRecoveryEntry[];
+        }>;
     };
     observables: {
         status: Observable<INetworkStatusSummary>;
@@ -228,8 +292,24 @@ export interface INetworkControlConsumer extends IContractConsumerBase {
         syncGroupNow(input: {
             groupId: string;
         }): Promise<INetworkControlResult>;
-        resetChangeTracking(input: {
+        resetChangeTracking(input?: {
+            dataContextId?: string;
+        }): Promise<INetworkControlResult>;
+        resetDeviceSyncInfo(input?: {
+            dataContextId?: string;
+        }): Promise<INetworkControlResult>;
+        retrySyncRecovery(input: {
+            dataContextId: string;
+            tableName?: string;
+            recordId?: string;
+            syncRecoveryId?: string;
+        }): Promise<INetworkControlResult>;
+        resolveSyncRecovery(input: {
             dataContextId: string;
+            tableName: string;
+            recordId: string;
+            resolution: SyncRecoveryResolution;
+            syncRecoveryId?: string;
         }): Promise<INetworkControlResult>;
     };
 }

package/dist/contracts/system/network-contracts.js

@@ -19,6 +19,7 @@ exports.networkDiagnosticsToolIds = {
     getGroupDetails: "00ms1yb50yuru8h1fg4t9na3e",
     getDisconnectedDevices: "00ms1yb50y3jpoby5zomltahr",
     queryRemoteLogs: "00ms1yb50y2fbfnth22yz52eu",
+    getSyncRecoveryEntries: "00mujw2tgbpoohxvwd23u9moz",
 };
 /** Stable IDs for tools in System Network Control v1. */
 exports.networkControlToolIds = {
@@ -28,6 +29,9 @@ exports.networkControlToolIds = {
     deleteDevice: "00ms1yb50y5mc448nuavlex86",
     syncGroupNow: "00ms1yb50ylnqlra26jx232py",
     resetChangeTracking: "00ms1yb50yfuackpl1w37hmxc",
+    retrySyncRecovery: "00mujw2tgcelvpg556n836ah7",
+    resolveSyncRecovery: "00mujw2tgciywn8krykc6gmwx",
+    resetDeviceSyncInfo: "00mujw2tgc5lrezqrw4oneaot",
 };
 const field = (name, type, description, opts = {}) => ({ name, type, description, ...opts });
 let diagnosticsDefinition;
@@ -106,6 +110,18 @@ function getNetworkDiagnosticsContractDefinition() {
                     field("queriedAt", field_type_1.FieldType.number, "Local completion timestamp."),
                 ],
             },
+            {
+                name: "getSyncRecoveryEntries",
+                usageDescription: "List records whose synchronized changes could not be materialized.",
+                inputFields: [
+                    field("dataContextId", field_type_1.FieldType.id, "Optional personal or group context ID.", {
+                        optional: true,
+                    }),
+                ],
+                outputFields: [
+                    field("entries", field_type_1.FieldType.object, "Recovery queue entries.", { isArray: true }),
+                ],
+            },
         ],
         observables: [
             {
@@ -166,9 +182,46 @@ function getNetworkControlContractDefinition() {
             },
             {
                 name: "resetChangeTracking",
-                usageDescription: "Reset one data context's change tracking for an expensive full sync.",
+                usageDescription: "Reset change tracking for one data context, or every local context when omitted.",
+                inputFields: [
+                    field("dataContextId", field_type_1.FieldType.id, "Personal or group context ID to reset.", {
+                        optional: true,
+                    }),
+                ],
+                outputFields: resultFields,
+            },
+            {
+                name: "resetDeviceSyncInfo",
+                usageDescription: "Clear device sync checkpoints for one data context, or every local context when omitted.",
+                inputFields: [
+                    field("dataContextId", field_type_1.FieldType.id, "Personal or group context ID to reset.", {
+                        optional: true,
+                    }),
+                ],
+                outputFields: resultFields,
+            },
+            {
+                name: "retrySyncRecovery",
+                usageDescription: "Retry one recovery entry, or every entry in a data context.",
+                inputFields: [
+                    field("dataContextId", field_type_1.FieldType.id, "Personal or group context ID."),
+                    field("tableName", field_type_1.FieldType.string, "Table of one entry to retry.", { optional: true }),
+                    field("recordId", field_type_1.FieldType.string, "Record id of one entry to retry.", {
+                        optional: true,
+                    }),
+                    field("syncRecoveryId", field_type_1.FieldType.id, "Queue row to retry. When set, a replaced row is not retried.", { optional: true }),
+                ],
+                outputFields: resultFields,
+            },
+            {
+                name: "resolveSyncRecovery",
+                usageDescription: "Resolve one recovery entry by snapshotting this device, tombstoning the record, or ignoring it locally.",
                 inputFields: [
-                    field("dataContextId", field_type_1.FieldType.id, "Personal or group context ID to reset."),
+                    field("dataContextId", field_type_1.FieldType.id, "Personal or group context ID."),
+                    field("tableName", field_type_1.FieldType.string, "Table of the queued record."),
+                    field("recordId", field_type_1.FieldType.string, "Record id of the queued record."),
+                    field("resolution", field_type_1.FieldType.string, "keepLocal, deleteEverywhere, or ignoreLocal."),
+                    field("syncRecoveryId", field_type_1.FieldType.id, "Queue row to resolve. When set, a replaced row is left unchanged.", { optional: true }),
                 ],
                 outputFields: resultFields,
             },

package/dist/data/change-tracking.d.ts

@@ -133,6 +133,11 @@ export declare class ChangeTrackingTable extends SQLDataSource<IChangeRecord> {
      * than `supersededAt`. Used after a root snapshot, delete, or restore.
      */
     markAllPriorChangesSuperseded(tableName: string, recordId: string, supersededAt: number): Promise<void>;
+    /**
+     * Synchronous form of {@link markAllPriorChangesSuperseded} for an open
+     * writer transaction. The table must already be initialized.
+     */
+    markAllPriorChangesSupersededSync(tableName: string, recordId: string, supersededAt: number): void;
     /**
      * Batch update supersededAt timestamps for multiple changes.
      * More efficient than updating one at a time.

package/dist/data/change-tracking.js

@@ -236,6 +236,24 @@ class ChangeTrackingTable extends orm_1.SQLDataSource {
         supersededAt IS NULL 
     `, { tableName, recordId, supersededAt });
     }
+    /**
+     * Synchronous form of {@link markAllPriorChangesSuperseded} for an open
+     * writer transaction. The table must already be initialized.
+     */
+    markAllPriorChangesSupersededSync(tableName, recordId, supersededAt) {
+        if (!this.db.execSync) {
+            throw new Error("Recovery writes require a synchronous database");
+        }
+        this.db.execSync(`
+      UPDATE "${this.tableName}"
+      SET supersededAt = $supersededAt
+      WHERE
+        tableName = $tableName AND
+        recordId = $recordId AND
+        createdAt < $supersededAt AND
+        supersededAt IS NULL
+    `, { tableName, recordId, supersededAt });
+    }
     /**
      * Batch update supersededAt timestamps for multiple changes.
      * More efficient than updating one at a time.

package/dist/data/index.d.ts

@@ -14,6 +14,7 @@ export * from "./group-secret";
 export * from "./group-share";
 export * from "./groups";
 export * from "./invites";
+export * from "./local-folders";
 export * from "./messages";
 export * from "./package-table-identity";
 export * from "./package-version-resolver";

package/dist/data/index.js

@@ -30,6 +30,7 @@ __exportStar(require("./group-secret"), exports);
 __exportStar(require("./group-share"), exports);
 __exportStar(require("./groups"), exports);
 __exportStar(require("./invites"), exports);
+__exportStar(require("./local-folders"), exports);
 __exportStar(require("./messages"), exports);
 __exportStar(require("./package-table-identity"), exports);
 __exportStar(require("./package-version-resolver"), exports);

package/dist/data/local-folders.d.ts

@@ -0,0 +1,176 @@
+import { z } from "zod";
+import type { DataContext } from "../context/data-context";
+import { type ITableMetaData } from "./orm/types";
+/** Content-defined block descriptor stored on an indexed file. */
+export declare const localFolderBlockSchema: z.ZodObject<{
+    hash: z.ZodString;
+    size: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    size: number;
+    hash: string;
+}, {
+    size: number;
+    hash: string;
+}>;
+/** One content-defined block: hash and length. */
+export type ILocalFolderBlock = z.infer<typeof localFolderBlockSchema>;
+/** Access mode recorded on a folder grant. */
+export declare const localFolderGrantModeSchema: z.ZodEnum<["read", "readwrite"]>;
+/** `read` lists and reads; `readwrite` may also move, trash, and index. */
+export type LocalFolderGrantMode = z.infer<typeof localFolderGrantModeSchema>;
+/**
+ * Operator grant of one absolute folder to an optional package.
+ * Stored only on this device, in the personal database.
+ */
+export declare const localFolderGrantSchema: z.ZodObject<{
+    grantId: z.ZodEffects<z.ZodString, string, string>;
+    packageId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    groupId: z.ZodEffects<z.ZodString, string, string>;
+    absolutePath: z.ZodString;
+    mode: z.ZodEnum<["read", "readwrite"]>;
+    createdAt: z.ZodNumber;
+    revokedAt: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    groupId: string;
+    createdAt: number;
+    mode: "readwrite" | "read";
+    grantId: string;
+    absolutePath: string;
+    packageId?: string | undefined;
+    revokedAt?: number | undefined;
+}, {
+    groupId: string;
+    createdAt: number;
+    mode: "readwrite" | "read";
+    grantId: string;
+    absolutePath: string;
+    packageId?: string | undefined;
+    revokedAt?: number | undefined;
+}>;
+/** A device-local folder grant. */
+export type ILocalFolderGrant = z.infer<typeof localFolderGrantSchema>;
+/** Indexed file under a grant. One row per `(grantId, relPath)`. */
+export declare const localFolderFileSchema: z.ZodObject<{
+    fileIndexId: z.ZodEffects<z.ZodString, string, string>;
+    grantId: z.ZodEffects<z.ZodString, string, string>;
+    relPath: z.ZodString;
+    size: z.ZodNumber;
+    mtimeMs: z.ZodNumber;
+    inode: z.ZodString;
+    blocks: z.ZodArray<z.ZodObject<{
+        hash: z.ZodString;
+        size: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        size: number;
+        hash: string;
+    }, {
+        size: number;
+        hash: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    size: number;
+    grantId: string;
+    relPath: string;
+    mtimeMs: number;
+    inode: string;
+    blocks: {
+        size: number;
+        hash: string;
+    }[];
+    fileIndexId: string;
+}, {
+    size: number;
+    grantId: string;
+    relPath: string;
+    mtimeMs: number;
+    inode: string;
+    blocks: {
+        size: number;
+        hash: string;
+    }[];
+    fileIndexId: string;
+}>;
+/** A local index row for one file. */
+export type ILocalFolderFile = z.infer<typeof localFolderFileSchema>;
+/**
+ * One servable block location. The same hash may appear in several files;
+ * `blockHash` is indexed, not unique.
+ */
+export declare const localFolderBlockRowSchema: z.ZodObject<{
+    blockRowId: z.ZodEffects<z.ZodString, string, string>;
+    blockHash: z.ZodString;
+    grantId: z.ZodEffects<z.ZodString, string, string>;
+    relPath: z.ZodString;
+    offset: z.ZodNumber;
+    length: z.ZodNumber;
+    mtimeMs: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    length: number;
+    offset: number;
+    grantId: string;
+    relPath: string;
+    mtimeMs: number;
+    blockRowId: string;
+    blockHash: string;
+}, {
+    length: number;
+    offset: number;
+    grantId: string;
+    relPath: string;
+    mtimeMs: number;
+    blockRowId: string;
+    blockHash: string;
+}>;
+/** A local index row mapping a block hash to a byte range in a real file. */
+export type ILocalFolderBlockRow = z.infer<typeof localFolderBlockRowSchema>;
+/** Table metadata for {@link LocalFolderGrants}. */
+export declare const localFolderGrantsMetaData: ITableMetaData;
+/** Table metadata for {@link LocalFolderFiles}. */
+export declare const localFolderFilesMetaData: ITableMetaData;
+/** Table metadata for {@link LocalFolderBlocks}. */
+export declare const localFolderBlocksMetaData: ITableMetaData;
+/**
+ * Device-local folder grants. Pass the personal data context; these rows do not sync.
+ *
+ * @param dataContext Context whose database holds the grants. Defaults to the current context.
+ */
+export declare function LocalFolderGrants(dataContext?: DataContext): import("..").Table<{
+    groupId: string;
+    createdAt: number;
+    mode: "readwrite" | "read";
+    grantId: string;
+    absolutePath: string;
+    packageId?: string | undefined;
+    revokedAt?: number | undefined;
+}>;
+/**
+ * Device-local indexed files. Pass the personal data context; these rows do not sync.
+ *
+ * @param dataContext Context whose database holds the index. Defaults to the current context.
+ */
+export declare function LocalFolderFiles(dataContext?: DataContext): import("..").Table<{
+    size: number;
+    grantId: string;
+    relPath: string;
+    mtimeMs: number;
+    inode: string;
+    blocks: {
+        size: number;
+        hash: string;
+    }[];
+    fileIndexId: string;
+}>;
+/**
+ * Device-local block locations. Pass the personal data context; these rows do not sync.
+ *
+ * @param dataContext Context whose database holds the index. Defaults to the current context.
+ */
+export declare function LocalFolderBlocks(dataContext?: DataContext): import("..").Table<{
+    length: number;
+    offset: number;
+    grantId: string;
+    relPath: string;
+    mtimeMs: number;
+    blockRowId: string;
+    blockHash: string;
+}>;