@lix-js/sdk 0.5.0-preview.0 → 0.5.0-preview.1

package/src/change/schema.ts

@@ -6,26 +6,63 @@ export function applyChangeDatabaseSchema(
 ): SqliteWasmDatabase {
 	return sqlite.exec(`
   CREATE TABLE IF NOT EXISTS internal_change (
-    id TEXT PRIMARY KEY DEFAULT (uuid_v7()),
+    id TEXT PRIMARY KEY DEFAULT (lix_uuid_v7()),
     entity_id TEXT NOT NULL,
     schema_key TEXT NOT NULL,
     schema_version TEXT NOT NULL,
     file_id TEXT NOT NULL,
     plugin_key TEXT NOT NULL,
     snapshot_id TEXT NOT NULL, -- Foreign key to internal_snapshot
-    created_at TEXT DEFAULT (strftime('%Y-%m-%dT%H:%M:%fZ', 'now')) NOT NULL CHECK (created_at LIKE '%Z'),
+    created_at TEXT DEFAULT (lix_timestamp()) NOT NULL CHECK (created_at LIKE '%Z'),
 
     UNIQUE (id, entity_id, file_id, schema_key),
     FOREIGN KEY(snapshot_id) REFERENCES internal_snapshot(id)
   ) STRICT;
 
+  -- add a table we use within the transaction
+  -- which is used by the state logic
+  -- defined here to avoid circular dependencies
+  CREATE TABLE IF NOT EXISTS internal_change_in_transaction (
+    id TEXT PRIMARY KEY DEFAULT (lix_uuid_v7()),
+    entity_id TEXT NOT NULL,
+    schema_key TEXT NOT NULL,
+    schema_version TEXT NOT NULL,
+    file_id TEXT NOT NULL,
+    plugin_key TEXT NOT NULL,
+    version_id TEXT NOT NULL,
+    snapshot_content BLOB,
+    created_at TEXT NOT NULL CHECK (created_at LIKE '%Z'),
+    --- NOTE schena_key must be unique per entity_id and file_id in the transaction
+    UNIQUE(entity_id, file_id, schema_key, version_id)
+  ) STRICT;
+
   CREATE VIEW IF NOT EXISTS change AS
   SELECT 
-    c.*,
+    c.id,
+    c.entity_id,
+    c.schema_key,
+    c.schema_version,
+    c.file_id,
+    c.plugin_key,
+    c.created_at,
     (SELECT json(s.content)
      FROM internal_snapshot s
      WHERE s.id = c.snapshot_id) AS snapshot_content
-  FROM internal_change AS c;
+  FROM internal_change AS c
+  UNION ALL
+  SELECT 
+    t.id,
+    t.entity_id,
+    t.schema_key,
+    t.schema_version,
+    t.file_id,
+    t.plugin_key,
+    t.created_at,
+    CASE 
+      WHEN t.snapshot_content IS NULL THEN NULL
+      ELSE json(t.snapshot_content)
+    END AS snapshot_content
+  FROM internal_change_in_transaction AS t;
 
   CREATE TRIGGER IF NOT EXISTS change_insert
   INSTEAD OF INSERT ON change
@@ -33,11 +70,15 @@ export function applyChangeDatabaseSchema(
     -- Insert the snapshot first (if there's content)
     INSERT INTO internal_snapshot (id, content)
     SELECT 
-      uuid_v7(), 
+      lix_uuid_v7(), 
       jsonb(NEW.snapshot_content)
     WHERE NEW.snapshot_content IS NOT NULL
-      AND NOT EXISTS (SELECT 1 FROM internal_snapshot WHERE id = 'no-content' AND NEW.snapshot_content IS NULL);
-    
+      AND NOT EXISTS (
+        SELECT 1 FROM internal_snapshot 
+        WHERE id = 'no-content' 
+        AND NEW.snapshot_content IS NULL
+      );
+
     -- Insert the change, referencing the snapshot
     INSERT INTO internal_change (
       id,
@@ -49,7 +90,7 @@ export function applyChangeDatabaseSchema(
       snapshot_id,
       created_at
     ) VALUES (
-      COALESCE(NEW.id, uuid_v7()),
+      COALESCE(NEW.id, lix_uuid_v7()),
       NEW.entity_id,
       NEW.schema_key,
       NEW.schema_version,
@@ -59,7 +100,7 @@ export function applyChangeDatabaseSchema(
         WHEN NEW.snapshot_content IS NULL THEN 'no-content'
         ELSE (SELECT id FROM internal_snapshot WHERE content = jsonb(NEW.snapshot_content) ORDER BY id DESC LIMIT 1)
       END,
-      COALESCE(NEW.created_at, strftime('%Y-%m-%dT%H:%M:%fZ', 'now'))
+      COALESCE(NEW.created_at, lix_timestamp())
     );
   END;
 `);
@@ -79,8 +120,47 @@ export type InternalChangeTable = {
 	created_at: Generated<string>;
 };
 
-export type Change = Selectable<ChangeView>;
-export type NewChange = Insertable<ChangeView>;
+/**
+ * Raw change type with snapshot_content as a JSON string or null.
+ *
+ * This type exists to avoid parsing and serializing the snapshot_content
+ * when working directly with database operations or internal cache functions.
+ * Use this type when you need to work with the raw JSON string representation
+ * of the snapshot content.
+ *
+ * @example
+ * ```typescript
+ * const rawChange: LixChangeRaw = {
+ *   id: "change-123",
+ *   entity_id: "entity-456",
+ *   // ... other fields
+ *   snapshot_content: JSON.stringify({ key: "value" }) // JSON string
+ * };
+ * ```
+ */
+export type LixChangeRaw = Omit<LixChange, "snapshot_content"> & {
+	snapshot_content: string | null; // JSON string or null
+};
+
+/**
+ * Change type with parsed snapshot_content as a JavaScript object.
+ *
+ * This is the standard change type used throughout the application when
+ * working with business logic. The snapshot_content field is automatically
+ * parsed from JSON into a JavaScript object for easy manipulation.
+ *
+ * @example
+ * ```typescript
+ * const change: LixChange = {
+ *   id: "change-123",
+ *   entity_id: "entity-456",
+ *   // ... other fields
+ *   snapshot_content: { key: "value" } // Parsed JavaScript object
+ * };
+ * ```
+ */
+export type LixChange = Selectable<ChangeView>;
+export type NewLixChange = Insertable<ChangeView>;
 export type ChangeView = {
 	id: Generated<string>;
 	entity_id: string;

package/src/change-author/index.ts

@@ -1 +1,4 @@
-export { LixChangeAuthorSchema, type ChangeAuthor } from "./schema.js";
+export {
+	LixChangeAuthorSchema,
+	type LixChangeAuthor as ChangeAuthor,
+} from "./schema.js";