@lix-js/sdk 0.1.0 → 0.2.0

package/dist/services/telemetry/capture.test.js

@@ -0,0 +1,37 @@
+import { expect, test, vi } from "vitest";
+import { capture } from "./capture.js";
+test("it should not capture if telemetry is off", async () => {
+    global.fetch = vi.fn(() => Promise.resolve(new Response()));
+    vi.mock("../env-variables/index.js", async () => {
+        return {
+            ENV_VARIABLES: {
+                LIX_SDK_POSTHOG_TOKEN: "mock-defined",
+            },
+        };
+    });
+    await capture("LIX-SDK lix opened", {
+        lixId: "test",
+        accountId: "test",
+        telemetryKeyValue: "off",
+        properties: {},
+    });
+    expect(global.fetch).not.toHaveBeenCalled();
+});
+test("it should not capture if telemetry is NOT off", async () => {
+    global.fetch = vi.fn(() => Promise.resolve(new Response()));
+    vi.mock("../env-variables/index.js", async () => {
+        return {
+            ENV_VARIABLES: {
+                LIX_SDK_POSTHOG_TOKEN: "mock-defined",
+            },
+        };
+    });
+    await capture("LIX-SDK lix opened", {
+        lixId: "test",
+        accountId: "test",
+        telemetryKeyValue: "on",
+        properties: {},
+    });
+    expect(global.fetch).toHaveBeenCalled();
+});
+//# sourceMappingURL=capture.test.js.map

package/dist/services/telemetry/capture.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"capture.test.js","sourceRoot":"","sources":["../../../src/services/telemetry/capture.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,IAAI,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;IAC5D,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC;IAE5D,EAAE,CAAC,IAAI,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QAC/C,OAAO;YACN,aAAa,EAAE;gBACd,qBAAqB,EAAE,cAAc;aACrC;SACD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,CAAC,oBAAoB,EAAE;QACnC,KAAK,EAAE,MAAM;QACb,SAAS,EAAE,MAAM;QACjB,iBAAiB,EAAE,KAAK;QACxB,UAAU,EAAE,EAAE;KACd,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;AAC7C,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;IAChE,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC;IAE5D,EAAE,CAAC,IAAI,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QAC/C,OAAO;YACN,aAAa,EAAE;gBACd,qBAAqB,EAAE,cAAc;aACrC;SACD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,CAAC,oBAAoB,EAAE;QACnC,KAAK,EAAE,MAAM;QACb,SAAS,EAAE,MAAM;QACjB,iBAAiB,EAAE,IAAI;QACvB,UAAU,EAAE,EAAE;KACd,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,gBAAgB,EAAE,CAAC;AACzC,CAAC,CAAC,CAAC"}

package/dist/sync/sync-process.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sync-process.d.ts","sourceRoot":"","sources":["../../src/sync/sync-process.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAC;AAK9C,wBAAsB,eAAe,CAAC,IAAI,EAAE;IAC3C,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,GAAG,QAAQ,GAAG,QAAQ,CAAC,CAAC;CAC3C,GAAG,OAAO,CAAC,IAAI,CAAC,CA6EhB"}
+{"version":3,"file":"sync-process.d.ts","sourceRoot":"","sources":["../../src/sync/sync-process.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAC;AAK9C,wBAAsB,eAAe,CAAC,IAAI,EAAE;IAC3C,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,GAAG,QAAQ,GAAG,QAAQ,CAAC,CAAC;CAC3C,GAAG,OAAO,CAAC,IAAI,CAAC,CAkFhB"}

package/dist/sync/sync-process.js

@@ -60,14 +60,20 @@ export async function initSyncProcess(args) {
     };
     // naive implementation that syncs every second
     function schedulePullAndPush() {
-        if (args.lix.sqlite.isOpen()) {
-            pullAndPush().catch((e) => {
-                console.error("Error in sync process", e);
-            });
+        if (args.lix.sqlite.isOpen() === false) {
+            return;
         }
+        pullAndPush().catch((e) => {
+            if (e instanceof Error && e.message.includes("DB has been closed.")) {
+                // stop the syncing process, the database has been closed.
+                return;
+            }
+            console.error("Error in sync process", e);
+        });
+        // schedule next sync
         setTimeout(() => {
             schedulePullAndPush();
-        }, 1000);
+        }, 750);
     }
     schedulePullAndPush();
 }

package/dist/sync/sync-process.js.map

@@ -1 +1 @@
-{"version":3,"file":"sync-process.js","sourceRoot":"","sources":["../../src/sync/sync-process.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,IAErC;IACA,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE;SAC7B,UAAU,CAAC,WAAW,CAAC;SACvB,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,CAAC;SAC3B,MAAM,CAAC,OAAO,CAAC;SACf,uBAAuB,EAAE,CAAC;IAE5B,MAAM,WAAW,GAAG,KAAK,IAAI,EAAE;QAC9B,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE;aAClC,UAAU,CAAC,WAAW,CAAC;aACvB,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,UAAU,CAAC;aAC7B,MAAM,CAAC,OAAO,CAAC;aACf,gBAAgB,EAAE,CAAC;QAErB,IAAI,UAAU,EAAE,KAAK,KAAK,MAAM,EAAE,CAAC;YAClC,OAAO;QACR,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE;aAC3B,UAAU,CAAC,WAAW,CAAC;YACxB,yDAAyD;aACxD,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,gBAAgB,CAAC;aACnC,MAAM,CAAC,OAAO,CAAC;aACf,gBAAgB,EAAE,CAAC;QACrB,gDAAgD;QAChD,gDAAgD;QAChD,IAAI,CAAC,GAAG,EAAE,CAAC;YACV,OAAO;QACR,CAAC;QAED,IAAI,CAAC;YACJ,6DAA6D;YAC7D,MAAM,WAAW,GAAG,MAAM,cAAc,CAAC;gBACxC,SAAS,EAAE,GAAG,CAAC,KAAK;gBACpB,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,EAAE,EAAE,KAAK,CAAC,KAAK;aACf,CAAC,CAAC;YACH,eAAe;YACf,+EAA+E;YAC/E,eAAe;YACf,KAAK;YACL,2DAA2D;YAC3D,MAAM,YAAY,CAAC;gBAClB,SAAS,EAAE,GAAG,CAAC,KAAK;gBACpB,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,EAAE,EAAE,KAAK,CAAC,KAAK;gBACf,iBAAiB,EAAE,WAAW;aAC9B,CAAC,CAAC;QACJ,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,6CAA6C;YAC7C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAC3B,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,GAAG,aAAa,EAAE;gBACtC,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,MAAM,MAAM,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC;aACrC,CAAC,CACF,CAAC;YACF,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC7C,MAAM,CAAC,CAAC;YACT,CAAC;QACF,CAAC;QACD,gEAAgE;IACjE,CAAC,CAAC;IAEF,+CAA+C;IAE/C,SAAS,mBAAmB;QAC3B,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;YAC9B,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;gBACzB,OAAO,CAAC,KAAK,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC;YAC3C,CAAC,CAAC,CAAC;QACJ,CAAC;QACD,UAAU,CAAC,GAAG,EAAE;YACf,mBAAmB,EAAE,CAAC;QACvB,CAAC,EAAE,IAAI,CAAC,CAAC;IACV,CAAC;IAED,mBAAmB,EAAE,CAAC;AACvB,CAAC"}
+{"version":3,"file":"sync-process.js","sourceRoot":"","sources":["../../src/sync/sync-process.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,IAErC;IACA,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE;SAC7B,UAAU,CAAC,WAAW,CAAC;SACvB,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,CAAC;SAC3B,MAAM,CAAC,OAAO,CAAC;SACf,uBAAuB,EAAE,CAAC;IAE5B,MAAM,WAAW,GAAG,KAAK,IAAI,EAAE;QAC9B,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE;aAClC,UAAU,CAAC,WAAW,CAAC;aACvB,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,UAAU,CAAC;aAC7B,MAAM,CAAC,OAAO,CAAC;aACf,gBAAgB,EAAE,CAAC;QAErB,IAAI,UAAU,EAAE,KAAK,KAAK,MAAM,EAAE,CAAC;YAClC,OAAO;QACR,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE;aAC3B,UAAU,CAAC,WAAW,CAAC;YACxB,yDAAyD;aACxD,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,gBAAgB,CAAC;aACnC,MAAM,CAAC,OAAO,CAAC;aACf,gBAAgB,EAAE,CAAC;QACrB,gDAAgD;QAChD,gDAAgD;QAChD,IAAI,CAAC,GAAG,EAAE,CAAC;YACV,OAAO;QACR,CAAC;QACD,IAAI,CAAC;YACJ,6DAA6D;YAC7D,MAAM,WAAW,GAAG,MAAM,cAAc,CAAC;gBACxC,SAAS,EAAE,GAAG,CAAC,KAAK;gBACpB,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,EAAE,EAAE,KAAK,CAAC,KAAK;aACf,CAAC,CAAC;YACH,eAAe;YACf,+EAA+E;YAC/E,eAAe;YACf,KAAK;YACL,2DAA2D;YAC3D,MAAM,YAAY,CAAC;gBAClB,SAAS,EAAE,GAAG,CAAC,KAAK;gBACpB,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,EAAE,EAAE,KAAK,CAAC,KAAK;gBACf,iBAAiB,EAAE,WAAW;aAC9B,CAAC,CAAC;QACJ,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACZ,6CAA6C;YAC7C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAC3B,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,GAAG,aAAa,EAAE;gBACtC,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,MAAM,MAAM,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC;aACrC,CAAC,CACF,CAAC;YACF,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC7C,MAAM,CAAC,CAAC;YACT,CAAC;QACF,CAAC;QACD,gEAAgE;IACjE,CAAC,CAAC;IAEF,+CAA+C;IAE/C,SAAS,mBAAmB;QAC3B,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,KAAK,EAAE,CAAC;YACxC,OAAO;QACR,CAAC;QACD,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACzB,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,CAAC;gBACrE,0DAA0D;gBAC1D,OAAO;YACR,CAAC;YACD,OAAO,CAAC,KAAK,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QACH,qBAAqB;QACrB,UAAU,CAAC,GAAG,EAAE;YACf,mBAAmB,EAAE,CAAC;QACvB,CAAC,EAAE,GAAG,CAAC,CAAC;IACT,CAAC;IAED,mBAAmB,EAAE,CAAC;AACvB,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@lix-js/sdk",
   "type": "module",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "license": "Apache-2.0",
   "exports": {
     ".": "./dist/index.js"
@@ -16,17 +16,13 @@
   "engines": {
     "node": ">=21"
   },
-  "bundleDependencies": [
-    "@lix-js/server-api-schema",
-    "sqlite-wasm-kysely"
-  ],
   "dependencies": {
     "dedent": "1.5.1",
     "human-id": "^4.1.1",
     "js-sha256": "^0.11.0",
     "kysely": "^0.27.4",
     "uuid": "^10.0.0",
-    "sqlite-wasm-kysely": "0.1.0"
+    "sqlite-wasm-kysely": "0.1.1"
   },
   "devDependencies": {
     "@eslint/js": "^9.12.0",
@@ -41,9 +37,11 @@
     "@lix-js/server-api-schema": "0.1.1"
   },
   "scripts": {
+    "prebuild": "npm run env-variables",
     "build": "tsc --build",
     "test": "tsc --noEmit && vitest run --coverage",
     "test:watch": "vitest",
+    "env-variables": "node ./src/services/env-variables/create-index-file.js",
     "bench": "vitest bench",
     "lint": "eslint src/**/* --fix",
     "dev": "tsc --watch",

package/src/account/database-schema.test.ts

@@ -18,7 +18,7 @@ type AccountSchema = {
 	active_account: ActiveAccountTable;
 };
 
-test("account table should have no entry in the beginning and activte account should be an anonymous account", async () => {
+test("account table should have no entry but an active account", async () => {
 	const sqlite = await createInMemoryDatabase({
 		readOnly: false,
 	});
@@ -38,11 +38,8 @@ test("account table should have no entry in the beginning and activte account sh
 		}),
 	});
 
-	const account = await db
-		.selectFrom("account")
-		.selectAll()
-		.where("id", "=", "anonymous")
-		.execute();
+	const account = await db.selectFrom("account").selectAll().execute();
+
 	expect(account?.length).toBe(0);
 
 	const active_account = await db
@@ -50,7 +47,7 @@ test("account table should have no entry in the beginning and activte account sh
 		.selectAll()
 		.executeTakeFirst();
 
-	expect(active_account?.id).toBe("anonymous_mock_uuid_v7");
+	expect(active_account?.id).toBe("mock_uuid_v7");
 });
 
 test("account.id should default to uuid_v7", async () => {
@@ -131,7 +128,7 @@ test('it should drop the temp "current_account" table on reboot to not persist t
 		id: "test",
 	});
 
-	const blob = contentFromDatabase(sqlite);
+	const blob = contentFromDatabase(sqlite) as unknown as ArrayBuffer;
 
 	// re-open the database
 
@@ -158,7 +155,7 @@ test('it should drop the temp "current_account" table on reboot to not persist t
 		.executeTakeFirst();
 
 	expect(account2).toMatchObject({
-		id: "anonymous_mock_uuid_v7-2",
+		id: "mock_uuid_v7-2",
 	});
 });
 

package/src/account/database-schema.ts

@@ -21,10 +21,6 @@ export function applyAccountDatabaseSchema(
     name TEXT NOT NULL
   ) STRICT;
 
-  -- default anonymous account
-  -- INSERT OR IGNORE INTO account (id, name) 
-  -- VALUES ('anonymous', 'anonymous');
-
   -- current account(s)
   -- temp table because current accounts are session
   -- specific and should not be persisted
@@ -34,8 +30,8 @@ export function applyAccountDatabaseSchema(
     -- can't use foreign keys in temp tables... :(
   ) STRICT;
 
-  -- default to the anonymous account
-  INSERT INTO active_account (id, name) values ('anonymous_' || uuid_v7(), '${anonymousAccountName}');
+  -- default to a new account
+  INSERT INTO active_account (id, name) values (uuid_v7(), '${anonymousAccountName}');
 `;
 
 	return sqlite.exec(sql);

package/src/file-queue/file-queue-process.test.ts

@@ -104,8 +104,7 @@ test("should use queue and settled correctly", async () => {
 				content: {
 					text: "insert text",
 				},
-				// handles the author (which defaults to anonymous)
-				account_id: expect.stringMatching(/^anonymous_/),
+				account_id: expect.stringMatching(/./),
 			}),
 		])
 	);
@@ -209,7 +208,7 @@ test("should use queue and settled correctly", async () => {
 				content: {
 					text: "insert text",
 				},
-				account_id: expect.stringMatching(/^anonymous_/),
+				account_id: expect.stringMatching(/./),
 			}),
 			expect.objectContaining({
 				entity_id: "test",
@@ -219,7 +218,7 @@ test("should use queue and settled correctly", async () => {
 				content: {
 					text: "updated text",
 				},
-				account_id: expect.stringMatching(/^anonymous_/),
+				account_id: expect.stringMatching(/./),
 			}),
 			expect.objectContaining({
 				file_id: "test",
@@ -229,7 +228,7 @@ test("should use queue and settled correctly", async () => {
 				content: {
 					text: "second text update",
 				},
-				account_id: expect.stringMatching(/^anonymous_/),
+				account_id: expect.stringMatching(/./),
 			}),
 		])
 	);

package/src/file-queue/file-queue-process.ts

@@ -28,7 +28,6 @@ export async function initFileQueueProcess(args: {
 
 	async function queueWorker(trail = false) {
 		if (args.lix.sqlite.isOpen() === false) {
-			console.log("sqlite is closed");
 			return;
 		}
 
@@ -93,6 +92,10 @@ export async function initFileQueueProcess(args: {
 				queueWorker(true);
 			}
 		} catch (e) {
+			// database has been closed, ignore
+			if (e instanceof Error && e.message.includes("DB has been closed")) {
+				return;
+			}
 			console.error("file queue failed ", e);
 		}
 	}

package/src/lix/open-lix.test.ts

@@ -3,6 +3,7 @@ import { openLixInMemory } from "./open-lix-in-memory.js";
 import { newLixFile } from "./new-lix.js";
 import type { LixPlugin } from "../plugin/lix-plugin.js";
 import { toBlob } from "./to-blob.js";
+import { usedFileExtensions } from "./open-lix.js";
 
 test("providing plugins should be possible", async () => {
 	const mockPlugin: LixPlugin = {
@@ -43,3 +44,65 @@ test("providing key values should be possible", async () => {
 		.executeTakeFirstOrThrow();
 	expect(value1).toMatchObject({ key: "mock_key", value: "value2" });
 });
+
+test("providing an account should be possible", async () => {
+	const mockAccount = {
+		id: "mock-account",
+		name: "peter",
+	};
+
+	const lix = await openLixInMemory({
+		account: mockAccount,
+		blob: await newLixFile(),
+	});
+
+	const accounts = await lix.db
+		.selectFrom("active_account")
+		.selectAll()
+		.execute();
+
+	expect(accounts, "to be the provided account").toContainEqual(mockAccount);
+	expect(accounts, "no other active account is inserted").lengthOf(1);
+
+	await lix.db
+		.insertInto("key_value")
+		.values([{ key: "mock_key", value: "something" }])
+		.execute();
+
+	// lix automatically handles inserting the active account into the account table
+	const change = await lix.db
+		.selectFrom("change")
+		.innerJoin("change_author", "change_author.change_id", "change.id")
+		.where("schema_key", "=", "lix_key_value_table")
+		.where("entity_id", "=", "mock_key")
+		.select("change_author.account_id")
+		.executeTakeFirstOrThrow();
+
+	expect(change.account_id).toBe(mockAccount.id);
+});
+
+test("usedFileExtensions", async () => {
+	const lix = await openLixInMemory({
+		blob: await newLixFile(),
+	});
+	await lix.db
+		.insertInto("file")
+		.values([
+			{
+				path: "/test.txt",
+				data: new Uint8Array(),
+			},
+			{
+				path: "/test2.txt",
+				data: new Uint8Array(),
+			},
+			{
+				path: "/folder/folderwithdot./doc.pdf",
+				data: new Uint8Array(),
+			},
+		])
+		.execute();
+
+	const extensions = await usedFileExtensions(lix.db);
+	expect(new Set(extensions)).toEqual(new Set(["txt", "pdf"]));
+});

package/src/lix/open-lix.ts

@@ -3,10 +3,13 @@ import { loadPlugins } from "../plugin/load-plugin.js";
 import { type SqliteDatabase } from "sqlite-wasm-kysely";
 import { initDb } from "../database/init-db.js";
 import { initFileQueueProcess } from "../file-queue/file-queue-process.js";
-import type { Kysely } from "kysely";
+import { sql, type Kysely } from "kysely";
 import type { LixDatabaseSchema } from "../database/schema.js";
 import { initSyncProcess } from "../sync/sync-process.js";
 import type { NewKeyValue } from "../key-value/database-schema.js";
+import { capture } from "../services/telemetry/capture.js";
+import { ENV_VARIABLES } from "../services/env-variables/index.js";
+import type { Account } from "../account/database-schema.js";
 
 export type Lix = {
 	/**
@@ -30,6 +33,16 @@ export type Lix = {
  * Common setup between different lix environments.
  */
 export async function openLix(args: {
+	/**
+	 * The account that is opening this lix.
+	 *
+	 * Lix will automatically set the active account to the provided account.
+	 *
+	 * @example
+	 *   const account = localStorage.getItem("account")
+	 *   const lix = await openLix({ account })
+	 */
+	account?: Account;
 	database: SqliteDatabase;
 	/**
 	 * Usecase are lix apps that define their own file format,
@@ -65,6 +78,18 @@ export async function openLix(args: {
 			.execute();
 	}
 
+	if (args.account) {
+		await db.transaction().execute(async (trx) => {
+			// delete the default inserted active account from `initDb`
+			await trx.deleteFrom("active_account").execute();
+			await trx
+				.insertInto("active_account")
+				.values(args.account!)
+				.onConflict((oc) => oc.doUpdateSet(() => ({ ...args.account })))
+				.execute();
+		});
+	}
+
 	const plugins = await loadPlugins(db);
 	if (args.providePlugins && args.providePlugins.length > 0) {
 		plugins.push(...args.providePlugins);
@@ -78,9 +103,81 @@ export async function openLix(args: {
 
 	initSyncProcess({ lix: { db, plugin, sqlite: args.database } });
 
+	captureOpened({ db });
+
 	return {
 		db,
 		sqlite: args.database,
 		plugin,
 	};
 }
+
+async function captureOpened(args: { db: Kysely<LixDatabaseSchema> }) {
+	try {
+		const telemetry = await args.db
+			.selectFrom("key_value")
+			.select("value")
+			.where("key", "=", "lix_telemetry")
+			.executeTakeFirst();
+
+		if (telemetry?.value === "off") {
+			return;
+		}
+
+		const activeAccount = await args.db
+			.selectFrom("active_account")
+			.select("id")
+			.executeTakeFirstOrThrow();
+
+		const lixId = await args.db
+			.selectFrom("key_value")
+			.select("value")
+			.where("key", "=", "lix_id")
+			.executeTakeFirstOrThrow();
+
+		const fileExtensions = await usedFileExtensions(args.db);
+
+		await capture("LIX-SDK lix opened", {
+			accountId: activeAccount.id,
+			lixId: lixId.value,
+			telemetryKeyValue: telemetry?.value ?? "on",
+			properties: {
+				lix_sdk_version: ENV_VARIABLES.LIX_SDK_VERSION,
+				stored_file_extensions: fileExtensions,
+			},
+		});
+	} catch {
+		// ignore
+	}
+}
+
+/**
+ * Get all used file extensions.
+ */
+export async function usedFileExtensions(
+	db: Kysely<LixDatabaseSchema>
+): Promise<any> {
+	const result = await sql`
+	WITH RECURSIVE numbers(i) AS (
+		SELECT 1
+		UNION ALL
+		SELECT i + 1 FROM numbers WHERE i < 1000 -- Limit to 1000 characters for path length
+	),
+	REVERSED AS (
+		SELECT id,
+					GROUP_CONCAT(SUBSTR(path, LENGTH(path) - i + 1, 1), '') AS reversed_path
+		FROM file, numbers
+		WHERE i <= LENGTH(path)
+		GROUP BY id, path
+	),
+	EXTENSIONS AS (
+		SELECT DISTINCT SUBSTR(path, LENGTH(path) - INSTR(reversed_path, '.') + 2) AS extension
+		FROM file
+		JOIN REVERSED ON file.id = REVERSED.id
+		WHERE INSTR(reversed_path, '.') > 0
+	)
+	SELECT extension FROM EXTENSIONS;
+	`.execute(db);
+
+	return result.rows.map((row) => (row as any).extension);
+}

package/src/services/env-variables/create-index-file.js

@@ -0,0 +1,35 @@
+/* eslint-disable no-undef */
+/**
+ * This script writes public environment variables
+ * to an importable env file.
+ *
+ * - The SDK must bundle this file with the rest of the SDK
+ * - This scripts avoids the need for a bundler
+ * - Must be ran before building the SDK
+ */
+
+import fs from "node:fs/promises";
+import url from "node:url";
+import path from "node:path";
+
+const dirname = path.dirname(url.fileURLToPath(import.meta.url));
+
+const packageJson = JSON.parse(
+	await fs.readFile(path.resolve(dirname, "../../../package.json"), "utf-8")
+);
+
+await fs.writeFile(
+	dirname + "/index.ts",
+	`
+export const ENV_VARIABLES = {
+  LIX_SDK_POSTHOG_TOKEN: ${ifDefined(process.env.LIX_SDK_POSTHOG_TOKEN)},
+	LIX_SDK_VERSION: ${ifDefined(packageJson.version)},
+}
+`
+);
+
+// console.log("✅ Created env variable index file.");
+
+function ifDefined(value) {
+	return value ? `"${value}"` : undefined;
+}

package/src/services/env-variables/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Avoiding TypeScript errors before the `createIndexFile` script
+ * is invoked by defining the type ahead of time.
+ */
+
+/**
+ * Env variables that are available at runtime.
+ */
+export declare const ENV_VARIABLES: {
+	LIX_SDK_POSTHOG_TOKEN?: string;
+	/**
+	 * As defined in the package.json
+	 */
+	LIX_SDK_VERSION?: string;
+};

package/src/services/telemetry/capture.test.ts

@@ -0,0 +1,44 @@
+import { expect, test, vi } from "vitest";
+import { capture } from "./capture.js";
+
+test("it should not capture if telemetry is off", async () => {
+	global.fetch = vi.fn(() => Promise.resolve(new Response()));
+
+	vi.mock("../env-variables/index.js", async () => {
+		return {
+			ENV_VARIABLES: {
+				LIX_SDK_POSTHOG_TOKEN: "mock-defined",
+			},
+		};
+	});
+
+	await capture("LIX-SDK lix opened", {
+		lixId: "test",
+		accountId: "test",
+		telemetryKeyValue: "off",
+		properties: {},
+	});
+
+	expect(global.fetch).not.toHaveBeenCalled();
+});
+
+test("it should not capture if telemetry is NOT off", async () => {
+	global.fetch = vi.fn(() => Promise.resolve(new Response()));
+
+	vi.mock("../env-variables/index.js", async () => {
+		return {
+			ENV_VARIABLES: {
+				LIX_SDK_POSTHOG_TOKEN: "mock-defined",
+			},
+		};
+	});
+
+	await capture("LIX-SDK lix opened", {
+		lixId: "test",
+		accountId: "test",
+		telemetryKeyValue: "on",
+		properties: {},
+	});
+
+	expect(global.fetch).toHaveBeenCalled();
+});

package/src/services/telemetry/capture.ts

@@ -0,0 +1,99 @@
+import { ENV_VARIABLES } from "../env-variables/index.js";
+
+/**
+ * List of telemetry events for typesafety.
+ *
+ * - prefix with `SDK` to avoid collisions with other apps
+ * - use past tense to indicate that the event is completed
+ */
+type TelemetryEvent = "LIX-SDK lix opened";
+
+/**
+ * Capture an event.
+ *
+ * - manually calling the PostHog API because the SDKs were not platform angostic (and generally bloated)
+ */
+export const capture = async (
+	event: TelemetryEvent,
+	args: {
+		lixId: string;
+		accountId: string;
+		/**
+		 * The value of the telemetry key-value pair.
+		 *
+		 * @example
+		 *   const telemetryKeyValue = await lix.db.selectFrom("key_value").select("value").where("key", "=", "lix_telemetry").executeTakeFirstOrThrow();
+		 *   await capture("LIX-SDK opened lix", { lixId: "test", accountId: "test", telemetryKeyValue: telemetryKeyValue.value, properties: {} });
+		 */
+		telemetryKeyValue: string;
+		/**
+		 * Please use snake_case for property names.
+		 */
+		properties: Record<string, any>;
+	}
+): Promise<void> => {
+	if (ENV_VARIABLES.LIX_SDK_POSTHOG_TOKEN === undefined) {
+		return;
+	} else if (args.telemetryKeyValue === "off") {
+		return;
+	}
+	try {
+		await fetch("https://eu.posthog.com/capture/", {
+			method: "POST",
+			body: JSON.stringify({
+				api_key: ENV_VARIABLES.LIX_SDK_POSTHOG_TOKEN,
+				event,
+				distinct_id: args.accountId,
+				properties: {
+					$groups: { lix_id: args.lixId },
+					...args.properties,
+				},
+			}),
+		});
+		await identifyLix({
+			lixId: args.lixId,
+			accountId: args.accountId,
+			// using the id for now as a name but can be changed in the future
+			// we need at least one property to make a project visible in the dashboard
+			properties: { name: args.lixId },
+		});
+	} catch {
+		//
+	}
+};
+
+/**
+ * Identifying a project is needed.
+ *
+ * Otherwise, the project will not be visible in the PostHog dashboard.
+ */
+const identifyLix = async (args: {
+	lixId: string;
+	accountId: string;
+	properties: Record<string, string>;
+}) => {
+	// do not send events if the token is not set
+	// (assuming this eases testing)
+	if (ENV_VARIABLES.LIX_SDK_POSTHOG_TOKEN === undefined) {
+		return;
+	}
+	try {
+		await fetch("https://eu.posthog.com/capture/", {
+			method: "POST",
+			body: JSON.stringify({
+				api_key: ENV_VARIABLES.LIX_SDK_POSTHOG_TOKEN,
+				event: "$groupidentify",
+				distinct_id: args.accountId,
+				properties: {
+					$group_type: "lix",
+					$group_key: args.lixId,
+					$group_set: {
+						...args.properties,
+					},
+				},
+			}),
+		});
+	} catch {
+		//
+	}
+};