@lix-js/sdk 0.6.0-preview.1 → 0.6.0-preview.3

package/dist/generated/builtin-schemas.js

@@ -2,7 +2,6 @@
 // Source of truth: packages/engine/src/schema/builtin/*.json
 export const LixAccountSchema = {
     "x-lix-key": "lix_account",
-    "x-lix-version": "1",
     "x-lix-primary-key": [
         "/id"
     ],
@@ -24,7 +23,6 @@ export const LixAccountSchema = {
 };
 export const LixActiveAccountSchema = {
     "x-lix-key": "lix_active_account",
-    "x-lix-version": "1",
     "x-lix-primary-key": [
         "/account_id"
     ],
@@ -54,7 +52,6 @@ export const LixActiveAccountSchema = {
 };
 export const LixBinaryBlobRefSchema = {
     "x-lix-key": "lix_binary_blob_ref",
-    "x-lix-version": "1",
     "description": "Metadata pointer from a file version to its binary payload in internal CAS storage.",
     "x-lix-primary-key": [
         "/id"
@@ -84,8 +81,7 @@ export const LixBinaryBlobRefSchema = {
 };
 export const LixChangeSchema = {
     "x-lix-key": "lix_change",
-    "x-lix-version": "1",
-    "description": "Canonical immutable change fact. This surface represents the authoritative stream of journaled change facts. Commit lineage and non-commit scope are modeled separately around these facts.",
+    "description": "A change records one edit to a Lix entity, including what changed, when it changed, and which entity was affected.",
     "x-lix-primary-key": [
         "/id"
     ],
@@ -94,20 +90,20 @@ export const LixChangeSchema = {
         "id": {
             "type": "string",
             "x-lix-default": "lix_uuid_v7()",
-            "description": "Stable change identifier (UUIDv7). Referenced from `lix_commit.change_ids` and `lix_change_set_element.change_id`."
+            "description": "Stable identifier for this change."
         },
         "entity_id": {
-            "type": "string",
-            "description": "The entity this change applies to, scoped by (`schema_key`, `file_id`)."
+            "type": "array",
+            "description": "Canonical JSON primary-key tuple for the entity this change applies to, scoped by (`schema_key`, `file_id`). Values are ordered according to the target schema's `x-lix-primary-key`.",
+            "items": {
+                "type": "string"
+            },
+            "minItems": 1
         },
         "schema_key": {
             "type": "string",
             "description": "Schema identifier of the entity (e.g. `lix_file_descriptor`, `lix_commit`, or a user-registered key)."
         },
-        "schema_version": {
-            "type": "string",
-            "description": "Schema version the snapshot_content was written against (matches `x-lix-version` on the schema at write time)."
-        },
         "file_id": {
             "type": [
                 "string",
@@ -124,6 +120,9 @@ export const LixChangeSchema = {
         },
         "created_at": {
             "type": "string",
+            "examples": [
+                "2026-05-08T17:42:31.123Z"
+            ],
             "description": "ISO-8601 timestamp at which the change was recorded (set via `lix_timestamp()` at write time)."
         },
         "snapshot_content": {
@@ -138,7 +137,6 @@ export const LixChangeSchema = {
         "id",
         "entity_id",
         "schema_key",
-        "schema_version",
         "file_id",
         "created_at"
     ],
@@ -146,7 +144,6 @@ export const LixChangeSchema = {
 };
 export const LixChangeAuthorSchema = {
     "x-lix-key": "lix_change_author",
-    "x-lix-version": "1",
     "x-lix-primary-key": [
         "/change_id",
         "/account_id"
@@ -190,9 +187,14 @@ export const LixChangeAuthorSchema = {
     ],
     "additionalProperties": false
 };
-export const LixChangeSetSchema = {
-    "x-lix-key": "lix_change_set",
-    "x-lix-version": "1",
+export const LixCommitSchema = {
+    "x-lix-key": "lix_commit",
+    "description": "A commit is a stable point in project history. Versions point to commits. Use lix_commit_edge to inspect parent commits.",
+    "examples": [
+        {
+            "id": "commit_01jexample"
+        }
+    ],
     "x-lix-primary-key": [
         "/id"
     ],
@@ -200,7 +202,8 @@ export const LixChangeSetSchema = {
     "properties": {
         "id": {
             "type": "string",
-            "x-lix-default": "lix_uuid_v7()"
+            "x-lix-default": "lix_uuid_v7()",
+            "description": "Stable identifier of this commit."
         }
     },
     "required": [
@@ -208,149 +211,30 @@ export const LixChangeSetSchema = {
     ],
     "additionalProperties": false
 };
-export const LixChangeSetElementSchema = {
-    "x-lix-key": "lix_change_set_element",
-    "x-lix-version": "1",
-    "description": "Derived relational index mapping a change_set to the canonical changes introduced by its commit relative to the commit's first parent. Rebuildable from `lix_commit.change_ids` plus the referenced `lix_change` rows; the unique constraint enforces at most one change per (entity, schema, file) tuple within a single change_set.",
-    "x-lix-primary-key": [
-        "/change_set_id",
-        "/change_id"
-    ],
-    "x-lix-unique": [
-        [
-            "/change_set_id",
-            "/entity_id",
-            "/schema_key",
-            "/file_id"
-        ]
-    ],
-    "x-lix-foreign-keys": [
+export const LixCommitEdgeSchema = {
+    "x-lix-key": "lix_commit_edge",
+    "description": "Direct parent relationship between two commits. Merge commits have one row per parent. The first parent is useful for showing mainline history or comparing a merge commit against the commit that was checked out before the merge.",
+    "examples": [
         {
-            "properties": [
-                "/change_set_id"
-            ],
-            "references": {
-                "schemaKey": "lix_change_set",
-                "properties": [
-                    "/id"
-                ]
-            }
+            "parent_id": "commit-main",
+            "child_id": "commit-merge",
+            "parent_order": 0
         },
         {
-            "properties": [
-                "/change_id"
-            ],
-            "references": {
-                "schemaKey": "lix_change",
-                "properties": [
-                    "/id"
-                ]
-            }
-        }
-    ],
-    "type": "object",
-    "properties": {
-        "change_set_id": {
-            "type": "string",
-            "description": "The change_set this element belongs to (references `lix_change_set.id`)."
-        },
-        "change_id": {
-            "type": "string",
-            "description": "The canonical change introduced/adopted by the change_set's commit (references `lix_change.id`)."
-        },
-        "entity_id": {
-            "type": "string",
-            "description": "Denormalized from the referenced `lix_change` for fast entity-scoped queries and to anchor the unique constraint."
-        },
-        "schema_key": {
-            "type": "string",
-            "description": "Denormalized schema identifier from the referenced `lix_change`; part of the per-change_set uniqueness tuple."
-        },
-        "file_id": {
-            "type": [
-                "string",
-                "null"
-            ],
-            "description": "Denormalized file scope from the referenced `lix_change`; NULL for engine-internal entities. Part of the per-change_set uniqueness tuple."
+            "parent_id": "commit-feature",
+            "child_id": "commit-merge",
+            "parent_order": 1
         }
-    },
-    "required": [
-        "change_set_id",
-        "change_id",
-        "entity_id",
-        "schema_key",
-        "file_id"
     ],
-    "additionalProperties": false
-};
-export const LixCommitSchema = {
-    "x-lix-key": "lix_commit",
-    "x-lix-version": "1",
-    "description": "Commit header change. Canonical commit membership is stored in change_ids as the ordered list of canonical changes whose effects this commit introduces relative to its first parent. A merge commit may reference canonical changes originally authored in another parent instead of copying them. Derived projections such as lix_change_set_element must be rebuildable from this header plus the referenced change rows. Version head pointers such as lix_version_ref are maintained separately and are not commit members.",
     "x-lix-primary-key": [
-        "/id"
-    ],
-    "x-lix-foreign-keys": [
-        {
-            "properties": [
-                "/change_set_id"
-            ],
-            "references": {
-                "schemaKey": "lix_change_set",
-                "properties": [
-                    "/id"
-                ]
-            }
-        }
+        "/child_id",
+        "/parent_order"
     ],
-    "type": "object",
-    "properties": {
-        "id": {
-            "type": "string",
-            "x-lix-default": "lix_uuid_v7()",
-            "description": "Stable commit identifier."
-        },
-        "change_set_id": {
-            "type": "string",
-            "description": "Commit-local grouping identifier used by derived relational indexes and projections such as lix_change_set_element."
-        },
-        "change_ids": {
-            "type": "array",
-            "default": [],
-            "items": {
-                "type": "string"
-            },
-            "description": "Canonical ordered membership list of non-header change IDs whose effects this commit introduces relative to its first parent. Merge commits may reference existing changes from another parent instead of minting equivalent copies. Derived indexes such as lix_change_set_element must be rebuildable from this list. This does not include lix_version_ref pointer rows."
-        },
-        "author_account_ids": {
-            "type": "array",
-            "default": [],
-            "items": {
-                "type": "string"
-            },
-            "description": "Ordered set of author account IDs associated with this commit."
-        },
-        "parent_commit_ids": {
-            "type": "array",
-            "default": [],
-            "items": {
-                "type": "string"
-            },
-            "description": "Parent commit IDs for commit graph topology."
-        }
-    },
-    "required": [
-        "id",
-        "change_set_id"
-    ],
-    "additionalProperties": false
-};
-export const LixCommitEdgeSchema = {
-    "x-lix-key": "lix_commit_edge",
-    "x-lix-version": "1",
-    "x-lix-primary-key": [
-        "/parent_id",
-        "/child_id"
+    "x-lix-unique": [
+        [
+            "/parent_id",
+            "/child_id"
+        ]
     ],
     "x-lix-foreign-keys": [
         {
@@ -379,21 +263,32 @@ export const LixCommitEdgeSchema = {
     "type": "object",
     "properties": {
         "parent_id": {
-            "type": "string"
+            "type": "string",
+            "description": "Identifier of the parent commit."
         },
         "child_id": {
-            "type": "string"
+            "type": "string",
+            "description": "Identifier of the child commit."
+        },
+        "parent_order": {
+            "type": "integer",
+            "minimum": 0,
+            "examples": [
+                0,
+                1
+            ],
+            "description": "Zero-based position of this parent in the child commit's ordered parent list. The first parent has order 0; additional merge parents have order 1, 2, and so on."
         }
     },
     "required": [
         "parent_id",
-        "child_id"
+        "child_id",
+        "parent_order"
     ],
     "additionalProperties": false
 };
 export const LixDirectoryDescriptorSchema = {
     "x-lix-key": "lix_directory_descriptor",
-    "x-lix-version": "1",
     "x-lix-primary-key": [
         "/id"
     ],
@@ -444,72 +339,8 @@ export const LixDirectoryDescriptorSchema = {
     ],
     "additionalProperties": false
 };
-export const LixEntityLabelSchema = {
-    "x-lix-key": "lix_entity_label",
-    "x-lix-version": "1",
-    "x-lix-primary-key": [
-        "/entity_id",
-        "/schema_key",
-        "/file_id",
-        "/label_id"
-    ],
-    "x-lix-foreign-keys": [
-        {
-            "properties": [
-                "/entity_id",
-                "/schema_key",
-                "/file_id"
-            ],
-            "references": {
-                "schemaKey": "lix_state",
-                "properties": [
-                    "/entity_id",
-                    "/schema_key",
-                    "/file_id"
-                ]
-            }
-        },
-        {
-            "properties": [
-                "/label_id"
-            ],
-            "references": {
-                "schemaKey": "lix_label",
-                "properties": [
-                    "/id"
-                ]
-            }
-        }
-    ],
-    "type": "object",
-    "properties": {
-        "entity_id": {
-            "type": "string"
-        },
-        "schema_key": {
-            "type": "string"
-        },
-        "file_id": {
-            "type": [
-                "string",
-                "null"
-            ]
-        },
-        "label_id": {
-            "type": "string"
-        }
-    },
-    "required": [
-        "entity_id",
-        "schema_key",
-        "file_id",
-        "label_id"
-    ],
-    "additionalProperties": false
-};
 export const LixFileDescriptorSchema = {
     "x-lix-key": "lix_file_descriptor",
-    "x-lix-version": "1",
     "x-lix-primary-key": [
         "/id"
     ],
@@ -562,7 +393,6 @@ export const LixFileDescriptorSchema = {
 };
 export const LixKeyValueSchema = {
     "x-lix-key": "lix_key_value",
-    "x-lix-version": "1",
     "x-lix-primary-key": [
         "/key"
     ],
@@ -603,18 +433,25 @@ export const LixKeyValueSchema = {
 };
 export const LixLabelSchema = {
     "x-lix-key": "lix_label",
-    "x-lix-version": "1",
+    "description": "Catalog of labels that can be assigned to arbitrary live Lix rows through lix_label_assignment.",
     "x-lix-primary-key": [
         "/id"
     ],
+    "x-lix-unique": [
+        [
+            "/name"
+        ]
+    ],
     "type": "object",
     "properties": {
         "id": {
             "type": "string",
-            "x-lix-default": "lix_uuid_v7()"
+            "x-lix-default": "lix_uuid_v7()",
+            "description": "Stable label identifier. Label assignments reference this value."
         },
         "name": {
-            "type": "string"
+            "type": "string",
+            "description": "Human-readable label name. Unique across labels."
         }
     },
     "required": [
@@ -623,12 +460,84 @@ export const LixLabelSchema = {
     ],
     "additionalProperties": false
 };
+export const LixLabelAssignmentSchema = {
+    "x-lix-key": "lix_label_assignment",
+    "description": "Mapping table that assigns a label to any live Lix row addressed by (target_entity_id, target_schema_key, target_file_id). The state foreign-key tuple is ordered as [0] target_entity_id, [1] target_schema_key, [2] target_file_id.",
+    "x-lix-primary-key": [
+        "/id"
+    ],
+    "x-lix-unique": [
+        [
+            "/target_entity_id",
+            "/target_schema_key",
+            "/target_file_id",
+            "/label_id"
+        ]
+    ],
+    "x-lix-state-foreign-keys": [
+        [
+            "/target_entity_id",
+            "/target_schema_key",
+            "/target_file_id"
+        ]
+    ],
+    "x-lix-foreign-keys": [
+        {
+            "properties": [
+                "/label_id"
+            ],
+            "references": {
+                "schemaKey": "lix_label",
+                "properties": [
+                    "/id"
+                ]
+            }
+        }
+    ],
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "x-lix-default": "lix_uuid_v7()",
+            "description": "Stable identifier for this label assignment row."
+        },
+        "target_entity_id": {
+            "type": "array",
+            "description": "Target row entity_id. This is slot [0] in x-lix-state-foreign-keys and must be the canonical JSON array of string primary-key parts.",
+            "items": {
+                "type": "string"
+            },
+            "minItems": 1
+        },
+        "target_schema_key": {
+            "type": "string",
+            "description": "Target row schema key. This is slot [1] in x-lix-state-foreign-keys."
+        },
+        "target_file_id": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "description": "Target row file scope. This is slot [2] in x-lix-state-foreign-keys; null targets global rows."
+        },
+        "label_id": {
+            "type": "string",
+            "description": "Label assigned to the target row. References lix_label.id."
+        }
+    },
+    "required": [
+        "id",
+        "target_entity_id",
+        "target_schema_key",
+        "target_file_id",
+        "label_id"
+    ],
+    "additionalProperties": false
+};
 export const LixRegisteredSchemaSchema = {
     "x-lix-key": "lix_registered_schema",
-    "x-lix-version": "1",
     "x-lix-primary-key": [
-        "/value/x-lix-key",
-        "/value/x-lix-version"
+        "/value/x-lix-key"
     ],
     "type": "object",
     "properties": {
@@ -637,14 +546,10 @@ export const LixRegisteredSchemaSchema = {
             "properties": {
                 "x-lix-key": {
                     "type": "string"
-                },
-                "x-lix-version": {
-                    "type": "string"
                 }
             },
             "required": [
-                "x-lix-key",
-                "x-lix-version"
+                "x-lix-key"
             ],
             "additionalProperties": true
         }
@@ -656,7 +561,6 @@ export const LixRegisteredSchemaSchema = {
 };
 export const LixVersionDescriptorSchema = {
     "x-lix-key": "lix_version_descriptor",
-    "x-lix-version": "1",
     "description": "User-facing version metadata (name and visibility) for a branch-like version. The stable identity of a version; the matching `lix_version_ref` carries the moving head pointer. The catalog's `lix_version` surface joins this descriptor with its ref to present a single user-visible version row.",
     "x-lix-primary-key": [
         "/id"
@@ -691,7 +595,6 @@ export const LixVersionDescriptorSchema = {
 };
 export const LixVersionRefSchema = {
     "x-lix-key": "lix_version_ref",
-    "x-lix-version": "1",
     "description": "Version head pointer. Records which commit a version should currently resolve to in the local runtime. Intentionally not part of canonical commit membership: refs may be reset client-side after sync without introducing content conflicts. Each `lix_version_descriptor.id` has exactly one `lix_version_ref` row.",
     "x-lix-primary-key": [
         "/id"