@allourthings/core 0.1.10 → 1.0.0

package/README.md

@@ -1,52 +1,50 @@
 # allourthings-core
 
-Rust storage library for [All Our Things](https://allourthings.io) — an AI-powered household inventory system.
+Rust storage library for [AllOurThings](https://allourthings.io) — an AI-powered inventory system.
 
-Handles all reading and writing of catalog data. Shared across clients via platform-specific bindings:
 
-- **MCP server** — consumed as an npm package (`@allourthings/core`) via [napi-rs](https://napi.rs/) pre-built native addons
-- **iOS app** — consumed as a Swift Package Manager binary target via [UniFFI](https://mozilla.github.io/uniffi-rs/) XCFramework
+## Storage format
 
-## Usage
+Each item is a directory containing a single JSON file:
 
-```bash
-cargo test        # run all tests
-bun run build     # build the .node native addon for the MCP server
+```
+<data-dir>/items/<slug>-<id>/item.json
 ```
 
-## iOS distribution
+The directory name is `<slug>-<id>` where `<slug>` is a URL-safe lowercase version of the item name (max 50 chars) and `<id>` is an 8-character lowercase hex string. 
 
-### Local development
+Required fields: `id`, `name`, `created_at`, `updated_at`. Well-known optional fields include `category`, `subcategory`, `tags`, and `attachments`. Any additional fields are preserved and round-trip without modification.
 
-```bash
-./scripts/build-ios.sh          # release build (default)
-./scripts/build-ios.sh --debug  # debug build
-```
+Attachment files (PDFs, images, etc.) are stored alongside `item.json` in the same directory.
 
-This compiles the crate for all iOS targets, generates Swift bindings via UniFFI, and assembles a static XCFramework at `build/allourthings_core.xcframework`. The generated Swift bindings are committed to `Sources/AllourthingsCore/allourthings_core.swift`.
 
-In the iOS project, add `../allourthings-core` as a local Swift Package Manager dependency — Xcode resolves the XCFramework automatically.
+## Query cache
 
-### Published releases
+`CatalogStore` supports an optional SQLite query cache for efficient filtering.
 
-Tagging a version (e.g. `git tag v0.1.8 && git push origin v0.1.8`) triggers `.github/workflows/release-ios.yml`, which:
+The cache is write-through — every mutation (`add_item`, `update_item`, `delete_item`, and the attachment operations) updates the cache immediately. Call `refresh()` to sync changes written externally (e.g. by another process or a mobile app), and `rebuild_cache()` to fully repopulate from disk if the cache becomes corrupt.
 
-1. Builds the XCFramework for all iOS targets
-2. Zips it and computes the SPM checksum
-3. Patches `Package.swift` with the remote URL and checksum
-4. Commits and force-moves the tag, then creates a GitHub release with the zip attached
+| Platform | Default location |
+|---|---|
+| macOS | `~/Library/Caches/allourthings/<hash>/` |
+| Windows | `%LOCALAPPDATA%\allourthings\<hash>\` |
+| Linux | `~/.cache/allourthings/<hash>/` |
 
-iOS consumers can then depend on this repo via SPM without needing a Rust toolchain.
+The `<hash>` is a SHA-256 of the data directory path, so multiple vaults each get their own isolated cache.
 
-## Storage format
+The cache schema indexes `category`, `subcategory`, and `tags` for SQL filtering, and stores the full item as a JSON blob for everything else. All three are optional on any item — items missing them are stored and returned normally, they just won't appear when those specific filters are applied. Keeping the indexed columns to only those actually queried means new well-known fields can be added without any schema migration.
 
-Each item is a directory containing a single JSON file:
+## Running tests
 
+```bash
+cargo test
 ```
-<data-dir>/items/<slug>-<id>/item.json
-```
 
-Required fields: `id`, `name`, `created_at`, `updated_at`. All other fields are optional. Custom fields are preserved as-is and round-trip without modification.
+This runs two test suites:
+
+- **Unit tests** (in `src/`) — cover the item schema, slug generation, ID generation, storage CRUD, attachments, and cache write-through behaviour
+- **Conformance tests** (`tests/conformance.rs`) — assert against the shared fixtures in `test-fixtures/catalog/`. These define the canonical storage format that all AllOurThings clients (MCP server, iOS app, etc.) must honour
+
 
 ## License
 

package/index.d.ts

@@ -6,7 +6,7 @@
 /** Filter options for listItems, exposed as a plain JS object. */
 export interface JsListFilter {
   category?: string
-  location?: string
+  subcategory?: string
   tags?: Array<string>
 }
 /**
@@ -17,11 +17,17 @@ export interface JsListFilter {
  * blocking the event loop (operations are fast local filesystem I/O).
  */
 export declare class JsCatalogStore {
-  constructor(dataDir: string)
+  constructor(dataDir: string, cacheDir?: string | undefined | null)
+  refresh(): NapiResult
+  rebuildCache(): NapiResult
   addItem(newItem: any): NapiResult
   getItem(idOrName: string): NapiResult
   listItems(filter?: JsListFilter | undefined | null): NapiResult
   updateItem(id: string, updates: any): NapiResult
   deleteItem(id: string): NapiResult
   searchItems(query: string): NapiResult
+  getItemFields(): NapiResult
+  addAttachment(itemId: string, filename: string, kind: string, data: Buffer, label?: string | undefined | null): NapiResult
+  getAttachment(itemId: string, filename: string): NapiResult
+  deleteAttachment(itemId: string, filename: string): NapiResult
 }

package/index.js

@@ -37,7 +37,7 @@ switch (platform) {
           if (localFileExisted) {
             nativeBinding = require('./allourthings-core.android-arm64.node')
           } else {
-            nativeBinding = require('allourthings-core-android-arm64')
+            nativeBinding = require('@allourthings/core-android-arm64')
           }
         } catch (e) {
           loadError = e
@@ -49,7 +49,7 @@ switch (platform) {
           if (localFileExisted) {
             nativeBinding = require('./allourthings-core.android-arm-eabi.node')
           } else {
-            nativeBinding = require('allourthings-core-android-arm-eabi')
+            nativeBinding = require('@allourthings/core-android-arm-eabi')
           }
         } catch (e) {
           loadError = e
@@ -69,7 +69,7 @@ switch (platform) {
           if (localFileExisted) {
             nativeBinding = require('./allourthings-core.win32-x64-msvc.node')
           } else {
-            nativeBinding = require('allourthings-core-win32-x64-msvc')
+            nativeBinding = require('@allourthings/core-win32-x64-msvc')
           }
         } catch (e) {
           loadError = e
@@ -83,7 +83,7 @@ switch (platform) {
           if (localFileExisted) {
             nativeBinding = require('./allourthings-core.win32-ia32-msvc.node')
           } else {
-            nativeBinding = require('allourthings-core-win32-ia32-msvc')
+            nativeBinding = require('@allourthings/core-win32-ia32-msvc')
           }
         } catch (e) {
           loadError = e
@@ -97,7 +97,7 @@ switch (platform) {
           if (localFileExisted) {
             nativeBinding = require('./allourthings-core.win32-arm64-msvc.node')
           } else {
-            nativeBinding = require('allourthings-core-win32-arm64-msvc')
+            nativeBinding = require('@allourthings/core-win32-arm64-msvc')
           }
         } catch (e) {
           loadError = e
@@ -113,7 +113,7 @@ switch (platform) {
       if (localFileExisted) {
         nativeBinding = require('./allourthings-core.darwin-universal.node')
       } else {
-        nativeBinding = require('allourthings-core-darwin-universal')
+        nativeBinding = require('@allourthings/core-darwin-universal')
       }
       break
     } catch {}
@@ -124,7 +124,7 @@ switch (platform) {
           if (localFileExisted) {
             nativeBinding = require('./allourthings-core.darwin-x64.node')
           } else {
-            nativeBinding = require('allourthings-core-darwin-x64')
+            nativeBinding = require('@allourthings/core-darwin-x64')
           }
         } catch (e) {
           loadError = e
@@ -138,7 +138,7 @@ switch (platform) {
           if (localFileExisted) {
             nativeBinding = require('./allourthings-core.darwin-arm64.node')
           } else {
-            nativeBinding = require('allourthings-core-darwin-arm64')
+            nativeBinding = require('@allourthings/core-darwin-arm64')
           }
         } catch (e) {
           loadError = e
@@ -157,7 +157,7 @@ switch (platform) {
       if (localFileExisted) {
         nativeBinding = require('./allourthings-core.freebsd-x64.node')
       } else {
-        nativeBinding = require('allourthings-core-freebsd-x64')
+        nativeBinding = require('@allourthings/core-freebsd-x64')
       }
     } catch (e) {
       loadError = e
@@ -174,7 +174,7 @@ switch (platform) {
             if (localFileExisted) {
               nativeBinding = require('./allourthings-core.linux-x64-musl.node')
             } else {
-              nativeBinding = require('allourthings-core-linux-x64-musl')
+              nativeBinding = require('@allourthings/core-linux-x64-musl')
             }
           } catch (e) {
             loadError = e
@@ -187,7 +187,7 @@ switch (platform) {
             if (localFileExisted) {
               nativeBinding = require('./allourthings-core.linux-x64-gnu.node')
             } else {
-              nativeBinding = require('allourthings-core-linux-x64-gnu')
+              nativeBinding = require('@allourthings/core-linux-x64-gnu')
             }
           } catch (e) {
             loadError = e
@@ -203,7 +203,7 @@ switch (platform) {
             if (localFileExisted) {
               nativeBinding = require('./allourthings-core.linux-arm64-musl.node')
             } else {
-              nativeBinding = require('allourthings-core-linux-arm64-musl')
+              nativeBinding = require('@allourthings/core-linux-arm64-musl')
             }
           } catch (e) {
             loadError = e
@@ -216,7 +216,7 @@ switch (platform) {
             if (localFileExisted) {
               nativeBinding = require('./allourthings-core.linux-arm64-gnu.node')
             } else {
-              nativeBinding = require('allourthings-core-linux-arm64-gnu')
+              nativeBinding = require('@allourthings/core-linux-arm64-gnu')
             }
           } catch (e) {
             loadError = e
@@ -232,7 +232,7 @@ switch (platform) {
             if (localFileExisted) {
               nativeBinding = require('./allourthings-core.linux-arm-musleabihf.node')
             } else {
-              nativeBinding = require('allourthings-core-linux-arm-musleabihf')
+              nativeBinding = require('@allourthings/core-linux-arm-musleabihf')
             }
           } catch (e) {
             loadError = e
@@ -245,7 +245,7 @@ switch (platform) {
             if (localFileExisted) {
               nativeBinding = require('./allourthings-core.linux-arm-gnueabihf.node')
             } else {
-              nativeBinding = require('allourthings-core-linux-arm-gnueabihf')
+              nativeBinding = require('@allourthings/core-linux-arm-gnueabihf')
             }
           } catch (e) {
             loadError = e
@@ -261,7 +261,7 @@ switch (platform) {
             if (localFileExisted) {
               nativeBinding = require('./allourthings-core.linux-riscv64-musl.node')
             } else {
-              nativeBinding = require('allourthings-core-linux-riscv64-musl')
+              nativeBinding = require('@allourthings/core-linux-riscv64-musl')
             }
           } catch (e) {
             loadError = e
@@ -274,7 +274,7 @@ switch (platform) {
             if (localFileExisted) {
               nativeBinding = require('./allourthings-core.linux-riscv64-gnu.node')
             } else {
-              nativeBinding = require('allourthings-core-linux-riscv64-gnu')
+              nativeBinding = require('@allourthings/core-linux-riscv64-gnu')
             }
           } catch (e) {
             loadError = e
@@ -289,7 +289,7 @@ switch (platform) {
           if (localFileExisted) {
             nativeBinding = require('./allourthings-core.linux-s390x-gnu.node')
           } else {
-            nativeBinding = require('allourthings-core-linux-s390x-gnu')
+            nativeBinding = require('@allourthings/core-linux-s390x-gnu')
           }
         } catch (e) {
           loadError = e

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allourthings/core",
-  "version": "0.1.10",
+  "version": "1.0.0",
   "description": "Native storage core for All Our Things",
   "main": "index.js",
   "types": "index.d.ts",