@chronicle.app/foodnoms 0.4.0 → 0.5.0

package/README.md

@@ -10,8 +10,8 @@ Records are food entries, newest first, joined to their meal slot. `since`/`unti
 
 Each action happens at the entry's `timestamp` and is keyed by the entry's ID without its type. FoodNoms has no food-or-drink flag, so an entry whose name contains a common drink word becomes a `DrinkAction`, and anything else an `EatAction`. Keeping the type out of the key lets that guess change without changing the action's identity.
 
-The object is a `Meal` keyed by the same entry ID and named after the food. Its `category` is the meal slot: the built-in slots map to Breakfast, Lunch, Dinner and Snacks, a customized slot uses its own name, and an unnamed custom slot has none. The `description` joins the slot, brand, amount and calories.
+The object is a `Meal`, named after the food and keyed by the action it was eaten in (`action.sourceId`), so the entry's ID is the action's alone. Its `category` is the meal slot: the built-in slots map to Breakfast, Lunch, Dinner and Snacks, a customized slot uses its own name, and an unnamed custom slot has none. The `description` joins the slot, brand, amount and calories.
 
-The agent is the iCloud account owner from `@chronicle.app/icloud`. An explicit `account` object (or null) describes exported data without a host account lookup.
+The agent is the iCloud account owner from `@chronicle.app/apple`. An explicit `account` object (or null) describes exported data without a host account lookup.
 
 Tests use a synthetic FoodNoms database with an explicit `account`, so they never read the host's FoodNoms data or iCloud account.

package/dist/connectors/FoodNomsExtractor.d.ts

@@ -1,4 +1,4 @@
-import { Record } from '@chronicle.app/etl';
+import { Record, type Survey, type SurveyOptions } from '@chronicle.app/etl';
 import { SqliteExtractor } from '@chronicle.app/etl-sqlite';
 import FoodNomsTransformer from './FoodNomsTransformer.js';
 export declare class FoodNomsExtractor extends SqliteExtractor<typeof FoodNomsExtractor> {
@@ -24,6 +24,16 @@ export declare class FoodNomsExtractor extends SqliteExtractor<typeof FoodNomsEx
      * correctly against the column's space-separated text.
      */
     private toDbDate;
+    /**
+     * Entries eaten within since and until, both inclusive. A food in a saved
+     * collection (a recipe, a saved meal) is an entry too, but one never eaten,
+     * with no time or day, so it's left out.
+     */
+    private entryFilter;
+    /** Whether the entry table has a column, which an older FoodNoms may not. */
+    private hasColumn;
     extract(): AsyncGenerator<Record>;
+    /** The items a run reads, each one food or drink logged, and when they were eaten. */
+    survey(options?: SurveyOptions): Promise<Survey | null>;
 }
 //# sourceMappingURL=FoodNomsExtractor.d.ts.map

package/dist/connectors/FoodNomsExtractor.js

@@ -1,5 +1,5 @@
-import { SqliteExtractor, timeRangeConditions } from '@chronicle.app/etl-sqlite';
-import { getICloudAccount } from '@chronicle.app/icloud';
+import { SqliteExtractor, countsByMonth, monthSql, timeRangeConditions, } from '@chronicle.app/etl-sqlite';
+import { getICloudAccount } from '@chronicle.app/apple';
 import { z } from 'zod';
 import FoodNomsTransformer from './FoodNomsTransformer.js';
 /**
@@ -16,6 +16,11 @@ const BUILTIN_MEAL_TYPES = {
     '3': 'Dinner',
     '4': 'Snacks',
 };
+// When an entry was eaten: its time, or for one logged to a day without a
+// time, the middle of that day in UTC, so it falls on that day in any zone
+// within twelve hours. `day` is the day it was logged to, a Julian day number
+// in FoodNoms, which strftime reads as it does a date.
+const EATEN_AT = `COALESCE(f.date, strftime('%Y-%m-%d 12:00:00.000', f.day))`;
 export class FoodNomsExtractor extends SqliteExtractor {
     static source = 'foodnoms';
     static strategy = 'app-db';
@@ -60,19 +65,32 @@ export class FoodNomsExtractor extends SqliteExtractor {
     toDbDate(date) {
         return date.toISOString().replace('T', ' ').replace('Z', '');
     }
-    async *extract() {
-        if (!this.db) {
-            throw new Error('Database not initialized');
-        }
-        const conditions = [`1=1`];
-        const values = [];
-        const range = timeRangeConditions('f.date', this.config, {
+    /**
+     * Entries eaten within since and until, both inclusive. A food in a saved
+     * collection (a recipe, a saved meal) is an entry too, but one never eaten,
+     * with no time or day, so it's left out.
+     */
+    entryFilter() {
+        const range = timeRangeConditions(EATEN_AT, this.config, {
             convert: date => this.toDbDate(date),
             sinceOp: '>=',
             untilOp: '<=',
         });
-        conditions.push(...range.conditions);
-        values.push(...range.values);
+        const collected = this.hasColumn('collectionEditID') ? ['f.collectionEditID IS NULL'] : [];
+        return {
+            where: [`1=1`, ...collected, ...range.conditions].join(' AND '),
+            values: range.values,
+        };
+    }
+    /** Whether the entry table has a column, which an older FoodNoms may not. */
+    hasColumn(name) {
+        return Boolean(this.db.prepare(`SELECT 1 FROM pragma_table_info('foodEntryRecord') WHERE name = ?`).get(name));
+    }
+    async *extract() {
+        if (!this.db) {
+            throw new Error('Database not initialized');
+        }
+        const { where, values } = this.entryFilter();
         const limit = this.getEffectiveLimit();
         if (limit !== null) {
             values.push(limit);
@@ -82,6 +100,7 @@ export class FoodNomsExtractor extends SqliteExtractor {
         f.id,
         hex(f.entryID) as entryID,
         f.date,
+        ${EATEN_AT} as eatenAt,
         f.dateCreated,
         f.dateLastUpdated,
         f.tzID,
@@ -111,8 +130,8 @@ export class FoodNomsExtractor extends SqliteExtractor {
         END as mealSortIndex
       FROM foodEntryRecord f
       LEFT JOIN mealTypeRecord m ON f.mealTypeID = m.mealTypeID
-      WHERE ${conditions.join(' AND ')}
-      ORDER BY f.date DESC
+      WHERE ${where}
+      ORDER BY ${EATEN_AT} DESC
       ${limit === null ? '' : 'LIMIT ?'}
     `;
         const rows = this.db.prepare(query).all(...values);
@@ -136,6 +155,7 @@ export class FoodNomsExtractor extends SqliteExtractor {
                 entryID: this.hexToUuid(row.entryID),
                 nutrients,
                 date: row.date ? row.date + 'Z' : null,
+                eatenAt: row.eatenAt ? row.eatenAt + 'Z' : null,
                 dateCreated: row.dateCreated ? row.dateCreated + 'Z' : null,
                 dateLastUpdated: row.dateLastUpdated ? row.dateLastUpdated + 'Z' : null,
             };
@@ -162,4 +182,32 @@ export class FoodNomsExtractor extends SqliteExtractor {
             });
         }
     }
+    /** The items a run reads, each one food or drink logged, and when they were eaten. */
+    async survey(options = {}) {
+        if (!this.db)
+            return null;
+        const { where, values } = this.entryFilter();
+        const from = `FROM foodEntryRecord f
+      LEFT JOIN mealTypeRecord m ON f.mealTypeID = m.mealTypeID
+      WHERE ${where}`;
+        const row = this.db
+            .prepare(`SELECT COUNT(*) AS n, MIN(${EATEN_AT}) AS first, MAX(${EATEN_AT}) AS last ${from}`)
+            .get(...values);
+        // strftime reads the naive date strings as UTC too.
+        const month = monthSql(`CAST(strftime('%s', ${EATEN_AT}) AS INTEGER)`);
+        const byMonth = options.byMonth &&
+            countsByMonth(this.db
+                .prepare(`SELECT ${month} AS month, COUNT(*) AS n ${from} GROUP BY month`)
+                .all(...values));
+        // Naive UTC date strings, read as the UTC instants they are, as extract() does.
+        return {
+            meals: {
+                count: row.n,
+                label: 'items',
+                ...(row.first !== null && { earliest: new Date(row.first + 'Z') }),
+                ...(row.last !== null && { latest: new Date(row.last + 'Z') }),
+                ...(byMonth && { byMonth }),
+            },
+        };
+    }
 }

package/dist/connectors/FoodNomsTransformer.js

@@ -1,5 +1,5 @@
 import { ChronicleTransformer } from '@chronicle.app/etl';
-import { buildICloudPersonSchema } from '@chronicle.app/icloud';
+import { buildICloudPersonSchema } from '@chronicle.app/apple';
 /**
  * Conservative seed list of common beverages, matched whole-word against an
  * entry's name. FoodNoms records NO food-vs-drink flag — verified there is no
@@ -69,7 +69,8 @@ export default class FoodNomsTransformer extends ChronicleTransformer {
         const meal = this.buildMeal(record.data, record.context);
         const user = await this.buildUser(record.context.account);
         // One consume action per logged food entry. FoodNoms gives a single point in
-        // time (`date`), not a span, so it lands on `timestamp` rather than endTime.
+        // time (`date`), not a span, so it lands on `timestamp` rather than endTime:
+        // when it was eaten, which for an entry logged to a day alone is that day's.
         //
         // Identity is the consumption of this entry — keyed on the real entryID — and
         // `@type` is deliberately left OUT of the @key: eat-vs-drink is an inferred,
@@ -77,7 +78,7 @@ export default class FoodNomsTransformer extends ChronicleTransformer {
         // action. This also keeps FoodNoms consumptions shaped like the historical
         // `ate X` / `drank X` log so the two can sit on one timeline.
         const shared = {
-            timestamp: new Date(record.data.date),
+            timestamp: new Date(record.data.eatenAt ?? record.data.date),
             '@key': ['source', 'sourceId'],
             source: 'foodnoms',
             sourceId: record.data.entryID,
@@ -107,16 +108,17 @@ export default class FoodNomsTransformer extends ChronicleTransformer {
         return buildICloudPersonSchema(account);
     }
     buildMeal(data, context) {
-        // Key on `entryID`, the per-log CloudKit UUID FoodNoms assigns each entry.
-        // `foodID` looks like a shared food reference but for the dominant namespaces
-        // (`openai:` AI lookups, `local:` manual foods) it is a fresh UUID minted per
-        // entry, so it neither dedupes repeats nor is a real cross-log identity —
-        // using it would elevate a synthetic id to entity identity.
+        // Keyed by the consumption it was eaten in (`action.sourceId`, the entry's
+        // `entryID`, the per-log CloudKit UUID FoodNoms assigns each entry), which
+        // has that ID as its own. `foodID` looks like a shared food reference but
+        // for the dominant namespaces (`openai:` AI lookups, `local:` manual foods)
+        // it is a fresh UUID minted per entry, so it neither dedupes repeats nor is
+        // a real cross-log identity — using it would elevate a synthetic id to
+        // entity identity.
         const meal = {
             '@type': 'Meal',
-            '@key': ['@type', 'source', 'sourceId'],
+            '@key': ['@type', 'source', 'action.sourceId'],
             source: 'foodnoms',
-            sourceId: data.entryID,
             name: data.name,
         };
         // Classify the meal slot (Breakfast/Lunch/Dinner/Snacks) when known.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chronicle.app/foodnoms",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -22,9 +22,9 @@
   "type": "module",
   "description": "Chronicle plugin for FoodNoms meal tracking data",
   "devDependencies": {
-    "@chronicle.app/etl": "0.4.0",
-    "@chronicle.app/schema": "0.4.0",
-    "@chronicle.app/tsconfig": "0.4.0",
+    "@chronicle.app/etl": "0.5.0",
+    "@chronicle.app/schema": "0.5.0",
+    "@chronicle.app/tsconfig": "0.5.0",
     "@types/node": "^22.10.1",
     "typescript": "^5.7.2"
   },
@@ -39,8 +39,8 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@chronicle.app/etl-sqlite": "0.4.0",
-    "@chronicle.app/icloud": "0.4.0",
+    "@chronicle.app/etl-sqlite": "0.5.0",
+    "@chronicle.app/apple": "0.5.0",
     "zod": "^3.24.1"
   },
   "peerDependencies": {
@@ -66,11 +66,19 @@
             "recordTypes": [
               "meals"
             ],
-            "default": true
+            "default": true,
+            "locations": [
+              {
+                "path": "~/Library/Containers/com.algebraiclabs.foodnoms/Data/Documents/db.db"
+              }
+            ]
           }
         },
         "platforms": [
           "darwin"
+        ],
+        "requires": [
+          "full-disk-access"
         ]
       }
     }