@lix-js/sdk 0.1.0 → 0.3.0

package/src/query-filter/change-has-label.ts

@@ -7,7 +7,7 @@ import type { LixDatabaseSchema } from "../database/schema.js";
  * @example
  *   ```ts
  *   await lix.db.selectFrom("change")
- *      .where(changeHasLabel("confirmed"))
+ *      .where(changeHasLabel("checkpoint"))
  *      .selectAll()
  *      .execute();
  *   ```
@@ -17,7 +17,7 @@ import type { LixDatabaseSchema } from "../database/schema.js";
  *
  *   ```ts
  *   await lix.db.selectFrom("change")
- * 		.where((eb) => eb.not(changeHasLabel("confirmed")))
+ * 		.where((eb) => eb.not(changeHasLabel("checkpoint")))
  * 		.selectAll()
  * 		.execute();
  *   ```

package/src/query-filter/change-set-has-label.ts

@@ -7,7 +7,7 @@ import type { LixDatabaseSchema } from "../database/schema.js";
  * @example
  *   ```ts
  *   await lix.db.selectFrom("change_set")
- *      .where(changeSetHasLabel("confirmed"))
+ *      .where(changeSetHasLabel("checkpoint"))
  *      .selectAll()
  *      .execute();
  *   ```
@@ -17,7 +17,7 @@ import type { LixDatabaseSchema } from "../database/schema.js";
  *
  *   ```ts
  *   await lix.db.selectFrom("change_set")
- * 		.where((eb) => eb.not(changeSetHasLabel("confirmed")))
+ * 		.where((eb) => eb.not(changeSetHasLabel("checkpoint")))
  * 		.selectAll()
  * 		.execute();
  *   ```

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 {
+		//
+	}
+};

package/src/sync/sync-process.ts

@@ -34,7 +34,6 @@ export async function initSyncProcess(args: {
 		if (!url) {
 			return;
 		}
-
 		try {
 			// console.log("----------- PULL FROM SERVER -------------");
 			const serverState = await pullFromServer({
@@ -71,14 +70,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/node_modules/@lix-js/server-api-schema/.prettierrc.json

@@ -1,3 +0,0 @@
-{
-	"useTabs": true
-}

package/node_modules/@lix-js/server-api-schema/.vscode/extensions.json

@@ -1,3 +0,0 @@
-{
-	"recommendations": ["42crunch.vscode-openapi"]
-}

package/node_modules/@lix-js/server-api-schema/CHANGELOG.md

@@ -1,9 +0,0 @@
-# @lix-js/server-api-schema
-
-## 0.1.1
-
-### Patch Changes
-
-- 896602f: fix: emit .js file for node js
-
-  Otherwise, node js will throw "UNKNOWN FILE EXTENSION .ts".

package/node_modules/@lix-js/server-api-schema/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Opral US Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/node_modules/@lix-js/server-api-schema/package.json

@@ -1,21 +0,0 @@
-{
-	"private": true,
-	"name": "@lix-js/server-api-schema",
-	"type": "module",
-	"version": "0.1.1",
-	"license": "Apache-2.0",
-	"exports": {
-		".": "./dist/schema.js"
-	},
-	"scripts": {
-		"build": "npx openapi-typescript ./src/schema.yaml -o ./dist/schema.d.ts",
-		"format": "prettier ./src --write"
-	},
-	"_comment": "Required for tree-shaking https://webpack.js.org/guides/tree-shaking/#mark-the-file-as-side-effect-free",
-	"sideEffects": false,
-	"devDependencies": {
-		"openapi-typescript": "^7.4.3",
-		"prettier": "^3.3.3",
-		"typescript": "^5.5.4"
-	}
-}

package/node_modules/@lix-js/server-api-schema/src/schema.yaml

@@ -1,290 +0,0 @@
-openapi: 3.0.3
-info:
-  title: Lix Server Api
-  version: 1.0.0
-paths:
-  /lsa/new-v1:
-    post:
-      summary: Stores the lix on the server.
-      description: >
-        Use sync if you want to push or pull data from the server.
-      requestBody:
-        description: The lix binary.
-        required: true
-        content:
-          application/octet-stream:
-            schema:
-              format: binary
-
-      responses:
-        "201":
-          description: Lix file created successfully.
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  id:
-                    type: string
-                    description: The ID of the created lix.
-                    example: "123e4567-e89b-12d3-a456-426614174000"
-
-        "400":
-          description: Invalid Lix file.
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  error:
-                    type: string
-                    description: Error message.
-                    example: "Invalid Lix file."
-
-        "409":
-          description: Lix file already exists.
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  error:
-                    type: string
-                    description: Error message.
-                    example: "Lix file already exists."
-
-  /lsa/get-v1:
-    post:
-      summary: Get the lix from the server.
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              type: object
-              required:
-                - lix_id
-              properties:
-                lix_id:
-                  type: string
-                  description: The ID of the lix to get.
-                  example: "123e4567-e89b-12d3-a456-426614174000"
-      responses:
-        "200":
-          description: Lix file fetched successfully.
-          content:
-            application/octet-stream:
-              schema:
-                format: binary
-        "404":
-          description: Lix file not found.
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  error:
-                    type: string
-                    description: Error message.
-                    example: "Lix file not found."
-
-  /lsa/push-v1:
-    post:
-      summary: Push data to the server.
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              type: object
-              required:
-                - lix_id
-                - vector_clock
-                - data
-              properties:
-                lix_id:
-                  type: string
-                  description: The ID of the lix to push to.
-                  example: "123e4567-e89b-12d3-a456-426614174000"
-                vector_clock:
-                  type: array
-                  items:
-                    type: object
-                    description: The vector clock of the client.
-                    required:
-                      - session
-                      - time
-                    properties:
-                      session:
-                        type: string
-                        description: The session ID of the client.
-                        example: "123e4567-e"
-                      time:
-                        type: integer
-                        description: The time of the client.
-                        example: 123456789
-                    example:
-                      123e4567-e89b-12d3-a456-426614174000: 1
-                data:
-                  type: object
-                  description: The data to push.
-                  additionalProperties:
-                    type: array
-                    items:
-                      type: object
-                      additionalProperties: true
-                      example: >
-                        {
-                          "id": 1,
-                          "name": "Alice"
-                        }
-                  example: >
-                    {
-                      "table_name": [
-                      {
-                        "id": 1,
-                        "name": "Alice"
-                      }
-                      ]
-                    }
-
-      responses:
-        "201":
-          description: Rows pushed successfully.
-
-        "400":
-          description: Invalid row data.
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  code:
-                    type: string
-                    description: A machine-readable error code.
-                    example: "INVALID_ROW_DATA"
-                  message:
-                    type: string
-                    description: A human-readable error message.
-                    example: "The provided row data is invalid."
-
-        "404":
-          description: Lix not found.
-
-        "500":
-          description: Server error.
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  code:
-                    type: string
-                    description: Error message.
-                    example: "INTERNAL_SERVER_ERROR"
-                  message:
-                    type: string
-                    description: A human-readable error message.
-                    example: "An internal server error occurred."
-
-  /lsa/pull-v1:
-    post:
-      summary: Pull all data for all tables from the server.
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              type: object
-              required:
-                - lix_id
-                - vector_clock
-              properties:
-                lix_id:
-                  type: string
-                  description: The ID of the lix to pull from.
-                  example: "123e4567-e89b-12d3-a456-426614174000"
-                vector_clock:
-                  type: array
-                  items:
-                    type: object
-                    description: The vector clock of the client.
-                    required:
-                      - session
-                      - time
-                    properties:
-                      session:
-                        type: string
-                        description: The session ID of the client.
-                        example: "123e4567-e"
-                      time:
-                        type: integer
-                        description: The time of the client.
-                        example: 123456789
-      responses:
-        "200":
-          description: Data fetched successfully.
-          content:
-            application/json:
-              schema:
-                type: object
-                required:
-                  - vector_clock
-                  - data
-                properties:
-                  vector_clock:
-                    type: array
-                    items:
-                      type: object
-                      description: The vector clock of the server.
-                      required:
-                        - session
-                        - time
-                      properties:
-                        session:
-                          type: string
-                          description: The session ID of the server.
-                          example: "123e4567-e"
-                        time:
-                          type: integer
-                          description: The time of the server.
-                      example:
-                        session: 123e4567-e89b-12d3-a456-426614174000
-                        time: 1
-                  data:
-                    type: object
-                    description: The data to push.
-                    additionalProperties:
-                      type: array
-                      items:
-                        type: object
-                        additionalProperties: true
-                        example: >
-                          {
-                            "id": 1,
-                            "name": "Alice"
-                          }
-                    required:
-                      - vector_clock
-                    example: >
-                      {
-                        "table_name": [
-                        {
-                          "id": 1,
-                          "name": "Alice"
-                        }
-                        ]
-                      }
-        "404":
-          description: Lix file not found.
-        "500":
-          description: Failed to open the Lix file.
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  code:
-                    type: string
-                  message:
-                    type: string

package/node_modules/@lix-js/server-api-schema/tsconfig.json

@@ -1,20 +0,0 @@
-{
-	"extends": "../tsconfig.base.json",
-	"include": ["src/**/*"],
-	"compilerOptions": {
-		"allowJs": false,
-		"checkJs": false,
-		// isolated declarations lead to substantially faster build times
-		// which is overproportionally useful in a monorepo
-		// https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/#isolated-declarations
-		"isolatedDeclarations": true,
-		"allowImportingTsExtensions": false,
-		"emitDeclarationOnly": false,
-		// recommended by openapi-typescript https://openapi-ts.dev/introduction#setup
-		"noUncheckedIndexedAccess": true,
-		"module": "Node16",
-		"lib": ["ESNext"],
-		"outDir": "./dist",
-		"rootDir": "./src"
-	}
-}

package/node_modules/sqlite-wasm-kysely/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Opral US Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/node_modules/sqlite-wasm-kysely/README.md

@@ -1,11 +0,0 @@
-## Usage
-
-```ts
-const db = createInMemoryDatabase();
-
-const kysely = new Kysely<DB>({
-  dialect: createDialect({
-    database: db,
-  }),
-});
-```