@gitsheets/core-napi 0.4.0 → 0.5.0

package/binding.cjs

@@ -149,6 +149,9 @@ module.exports = {
   // the filter (equality / nested / `$pred` engine snippets) runs in the core.
   recordQuery: wrap(addon.recordQuery),
   recordQueryCandidates: wrap(addon.recordQueryCandidates),
+  treeReadBlob: wrap(addon.treeReadBlob),
+  treeEntryHash: wrap(addon.treeEntryHash),
+  blobRead: wrap(addon.blobRead),
   templateFieldNames: wrap(addon.templateFieldNames),
   // Secondary indexing (lazy, in-memory). A unique conflict surfaces as a typed
   // IndexError(index_unique_conflict).

package/index.d.ts

@@ -235,15 +235,47 @@ export declare function substrateReset(): void
 /**
  * Query records under `base` in the tree `treeRef`, returning each matched
  * `{ path, record }` in sorted path order. The template prunes the walk; the
- * filter (equality / nested / `$pred` snippets) is applied to each candidate.
- * Batch-first: the whole query crosses the FFI once.
+ * filter (equality / nested / `$pred` snippets / `{ $gt, $gte, $lt, $lte }` ranges)
+ * is applied to each candidate; a range on a date-bucket path field prunes
+ * the walk to the bounded span of partitions. Batch-first: the whole query
+ * crosses the FFI once.
+ *
+ * Format-aware: pass `bodyField` (and optionally `titleField`) for a
+ * markdown/mdx sheet (the kind follows `extension`: `.mdx` → mdx, else
+ * markdown) and the core decodes each candidate through the frontmatter
+ * codec — `withBody: false` is the lazy-body switch (default `true`). Without
+ * `bodyField` records are canonical TOML. The binding never fetches record
+ * bytes itself (spec: `rust-core.md` "Query traversal + filtering").
+ */
+export declare function recordQuery(gitDir: string, treeRef: string, base: string, template: string, filter: object, extension?: string | undefined | null, bodyField?: string | undefined | null, titleField?: string | undefined | null, withBody?: boolean | undefined | null): Array<JsRecordEntry>
+/**
+ * A blob read by `treeRef:path` — the bytes plus the blob's object id, or
+ * `null` when nothing (or a subtree) lives at `path`. Backs sheet-config
+ * loading and lazy-body hydration without a `git cat-file` subprocess
+ * (spec: `rust-core.md` "Blob reads").
  */
-export declare function recordQuery(gitDir: string, treeRef: string, base: string, template: string, filter: object, extension?: string | undefined | null): Array<JsRecordEntry>
+export declare function treeReadBlob(gitDir: string, treeRef: string, path: string): JsBlobEntry | null
+/**
+ * The object id of the blob at `treeRef:path`, or `null` when absent or not
+ * a blob. The hash-only lookup (attachment handles, cache keys).
+ */
+export declare function treeEntryHash(gitDir: string, treeRef: string, path: string): string | null
+/**
+ * A blob's bytes by object id, or `null` when no object has that id. Backs
+ * attachment content reads and diff-side record reads.
+ */
+export declare function blobRead(gitDir: string, hash: string): Buffer | null
+/** A blob read by `treeRef:path`: its object id and bytes. */
+export interface JsBlobEntry {
+  hash: string
+  content: Buffer
+}
 /**
  * The pruning candidate set alone (no content filter applied) — the direct
  * parity target for the host `Template.queryTree`. `query` is a (partial)
- * record of the path-template input fields. Returns candidate record paths
- * (relative to `base`, no extension) in sorted order.
+ * record of the path-template input fields; a date-bucket field may carry a
+ * `{ $gte, $lt, … }` range object, which bounds the walk. Returns candidate
+ * record paths (relative to `base`, no extension) in sorted order.
  */
 export declare function recordQueryCandidates(gitDir: string, treeRef: string, base: string, template: string, query: JsValue, extension?: string | undefined | null): Array<string>
 /**
@@ -510,6 +542,22 @@ export declare class CoreTransaction {
    * Read-only — does not mark the transaction mutated.
    */
   list(name: string, withBody: boolean): Array<JsRecordEntry>
+  /**
+   * Query the sheet's records in the transaction's private tree — pruned by
+   * the path template exactly like a committed-ref query, decoded through
+   * the format codec, `withBody` the lazy-body switch (spec:
+   * `api/transaction.md` "Read isolation"). The filter takes the same forms
+   * as `recordQuery` (equality / nested / `$pred` / ranges). Read-only —
+   * does not mark the transaction mutated.
+   */
+  query(name: string, filter: object, withBody: boolean): Array<JsRecordEntry>
+  /**
+   * Read the one record at `recordPath` (relative to the sheet's base, no
+   * extension) in the transaction's private tree, decoded through the format
+   * codec — the tx-bound `Sheet.get`. `null` when absent; `withBody` is the
+   * lazy-body switch. Read-only.
+   */
+  readRecord(name: string, recordPath: string, withBody: boolean): JsValue | null
   /** The parent commit hash captured at open (null on a fresh repo). */
   parentCommitHash(): string | null
   /**

package/index.js

@@ -310,7 +310,7 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { roundtrip, parseRecords, serializeRecords, renderPathsBatch, validateBatch, canonicalContractHash, validateContractName, contractPath, checkContractDocument, contractLoad, verifySheetContract, runComparator, collatorSort, CompiledDefinition, recordRead, recordWrite, recordDelete, recordList, writeBlob, substrateStats, substrateReset, recordQuery, recordQueryCandidates, templateFieldNames, recordIndexUnique, recordIndexMulti, createPatch, applyMergePatch, diffRecords, simulateCoreError, CoreTransaction, coreDiscoverSheets, coreCheckValidators, markdownSerialize, markdownNormalizeBody, markdownParse, markdownParseHeaderOnly, markdownExtractH1, markdownRewriteH1 } = nativeBinding
+const { roundtrip, parseRecords, serializeRecords, renderPathsBatch, validateBatch, canonicalContractHash, validateContractName, contractPath, checkContractDocument, contractLoad, verifySheetContract, runComparator, collatorSort, CompiledDefinition, recordRead, recordWrite, recordDelete, recordList, writeBlob, substrateStats, substrateReset, recordQuery, treeReadBlob, treeEntryHash, blobRead, recordQueryCandidates, templateFieldNames, recordIndexUnique, recordIndexMulti, createPatch, applyMergePatch, diffRecords, simulateCoreError, CoreTransaction, coreDiscoverSheets, coreCheckValidators, markdownSerialize, markdownNormalizeBody, markdownParse, markdownParseHeaderOnly, markdownExtractH1, markdownRewriteH1 } = nativeBinding
 
 module.exports.roundtrip = roundtrip
 module.exports.parseRecords = parseRecords
@@ -334,6 +334,9 @@ module.exports.writeBlob = writeBlob
 module.exports.substrateStats = substrateStats
 module.exports.substrateReset = substrateReset
 module.exports.recordQuery = recordQuery
+module.exports.treeReadBlob = treeReadBlob
+module.exports.treeEntryHash = treeEntryHash
+module.exports.blobRead = blobRead
 module.exports.recordQueryCandidates = recordQueryCandidates
 module.exports.templateFieldNames = templateFieldNames
 module.exports.recordIndexUnique = recordIndexUnique

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitsheets/core-napi",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Node.js native binding for gitsheets-core — the FFI marshalling boundary.",
   "main": "binding.cjs",
   "types": "index.d.ts",
@@ -33,12 +33,12 @@
     "index.d.ts"
   ],
   "optionalDependencies": {
-    "@gitsheets/core-napi-linux-x64-gnu": "0.4.0",
-    "@gitsheets/core-napi-linux-arm64-gnu": "0.4.0",
-    "@gitsheets/core-napi-linux-x64-musl": "0.4.0",
-    "@gitsheets/core-napi-darwin-arm64": "0.4.0",
-    "@gitsheets/core-napi-darwin-x64": "0.4.0",
-    "@gitsheets/core-napi-win32-x64-msvc": "0.4.0"
+    "@gitsheets/core-napi-linux-x64-gnu": "0.5.0",
+    "@gitsheets/core-napi-linux-arm64-gnu": "0.5.0",
+    "@gitsheets/core-napi-linux-x64-musl": "0.5.0",
+    "@gitsheets/core-napi-darwin-arm64": "0.5.0",
+    "@gitsheets/core-napi-darwin-x64": "0.5.0",
+    "@gitsheets/core-napi-win32-x64-msvc": "0.5.0"
   },
   "scripts": {
     "artifacts": "napi artifacts",
@@ -54,6 +54,6 @@
     "ajv": "^8.20.0",
     "ajv-formats": "^3.0.1",
     "rfc6902": "^5.2.0",
-    "smol-toml": "^1.7.0"
+    "smol-toml": "^1.8.0"
   }
 }