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

package/dist/generated/builtin-schemas.js

@@ -0,0 +1,744 @@
+// AUTO-GENERATED by scripts/sync-builtin-schemas.js
+// 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"
+    ],
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "x-lix-default": "lix_uuid_v7()"
+        },
+        "name": {
+            "type": "string"
+        }
+    },
+    "required": [
+        "id",
+        "name"
+    ],
+    "additionalProperties": false
+};
+export const LixActiveAccountSchema = {
+    "x-lix-key": "lix_active_account",
+    "x-lix-version": "1",
+    "x-lix-primary-key": [
+        "/account_id"
+    ],
+    "x-lix-foreign-keys": [
+        {
+            "properties": [
+                "/account_id"
+            ],
+            "references": {
+                "schemaKey": "lix_account",
+                "properties": [
+                    "/id"
+                ]
+            }
+        }
+    ],
+    "type": "object",
+    "properties": {
+        "account_id": {
+            "type": "string"
+        }
+    },
+    "required": [
+        "account_id"
+    ],
+    "additionalProperties": false
+};
+export const LixActiveVersionSchema = {
+    "x-lix-key": "lix_active_version",
+    "x-lix-version": "1",
+    "description": "Singleton tracking which version is currently checked out in the local runtime. Exactly one row exists at all times; writing to this surface is how clients switch versions.",
+    "x-lix-primary-key": [
+        "/id"
+    ],
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "description": "Fixed singleton key (constant, not a UUID); the primary-key column exists to satisfy entity-model requirements and enforces the one-row invariant."
+        },
+        "version_id": {
+            "type": "string",
+            "description": "The currently active version; references `lix_version_descriptor.id` and drives the default scope for reads and writes in the session."
+        }
+    },
+    "required": [
+        "id",
+        "version_id"
+    ],
+    "additionalProperties": false
+};
+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"
+    ],
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "description": "File/entity identifier (matches lix_file.id) for this binary reference row."
+        },
+        "blob_hash": {
+            "type": "string",
+            "description": "BLAKE3 content hash used as the canonical CAS key for the binary payload."
+        },
+        "size_bytes": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "Logical uncompressed file size in bytes for the referenced binary payload."
+        }
+    },
+    "required": [
+        "id",
+        "blob_hash",
+        "size_bytes"
+    ],
+    "additionalProperties": false
+};
+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. The public `untracked` field is retained as convenience metadata and should not be treated as proof that trackedness is intrinsic to the canonical fact row itself.",
+    "x-lix-primary-key": [
+        "/id"
+    ],
+    "type": "object",
+    "properties": {
+        "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`."
+        },
+        "entity_id": {
+            "type": "string",
+            "description": "The entity this change applies to, scoped by (`schema_key`, `file_id`)."
+        },
+        "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",
+                "null"
+            ],
+            "description": "Filesystem-scoped file identifier when the change belongs to a file; NULL for engine-internal entities (commits, versions, settings)."
+        },
+        "plugin_key": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "description": "Plugin that authored the change; NULL for engine-internal changes."
+        },
+        "metadata": {
+            "type": [
+                "object",
+                "null"
+            ],
+            "description": "Optional user-provided JSON metadata attached to the change; NULL when nothing was supplied."
+        },
+        "created_at": {
+            "type": "string",
+            "description": "ISO-8601 timestamp at which the change was recorded (set via `lix_timestamp()` at write time)."
+        },
+        "untracked": {
+            "type": "boolean",
+            "description": "Public convenience field indicating that the change currently participates in non-commit visibility rather than commit lineage. This is intended to become derived metadata rather than intrinsic canonical storage truth."
+        },
+        "snapshot_content": {
+            "type": [
+                "object",
+                "null"
+            ],
+            "description": "Entity JSON body at this change; NULL represents a tombstone (deletion)."
+        }
+    },
+    "required": [
+        "id",
+        "entity_id",
+        "schema_key",
+        "schema_version",
+        "file_id",
+        "plugin_key",
+        "created_at",
+        "untracked"
+    ],
+    "additionalProperties": false
+};
+export const LixChangeAuthorSchema = {
+    "x-lix-key": "lix_change_author",
+    "x-lix-version": "1",
+    "x-lix-primary-key": [
+        "/change_id",
+        "/account_id"
+    ],
+    "x-lix-foreign-keys": [
+        {
+            "properties": [
+                "/change_id"
+            ],
+            "references": {
+                "schemaKey": "lix_change",
+                "properties": [
+                    "/id"
+                ]
+            }
+        },
+        {
+            "properties": [
+                "/account_id"
+            ],
+            "references": {
+                "schemaKey": "lix_account",
+                "properties": [
+                    "/id"
+                ]
+            }
+        }
+    ],
+    "type": "object",
+    "properties": {
+        "change_id": {
+            "type": "string"
+        },
+        "account_id": {
+            "type": "string"
+        }
+    },
+    "required": [
+        "change_id",
+        "account_id"
+    ],
+    "additionalProperties": false
+};
+export const LixChangeSetSchema = {
+    "x-lix-key": "lix_change_set",
+    "x-lix-version": "1",
+    "x-lix-primary-key": [
+        "/id"
+    ],
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "x-lix-default": "lix_uuid_v7()"
+        }
+    },
+    "required": [
+        "id"
+    ],
+    "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 it contains. 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": [
+        {
+            "properties": [
+                "/change_set_id"
+            ],
+            "references": {
+                "schemaKey": "lix_change_set",
+                "properties": [
+                    "/id"
+                ]
+            }
+        },
+        {
+            "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 included in the change_set (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."
+        }
+    },
+    "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 non-header member changes for this commit. 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"
+                ]
+            }
+        }
+    ],
+    "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 that belong to this commit. 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-foreign-keys": [
+        {
+            "properties": [
+                "/parent_id"
+            ],
+            "references": {
+                "schemaKey": "lix_commit",
+                "properties": [
+                    "/id"
+                ]
+            }
+        },
+        {
+            "properties": [
+                "/child_id"
+            ],
+            "references": {
+                "schemaKey": "lix_commit",
+                "properties": [
+                    "/id"
+                ]
+            }
+        }
+    ],
+    "type": "object",
+    "properties": {
+        "parent_id": {
+            "type": "string"
+        },
+        "child_id": {
+            "type": "string"
+        }
+    },
+    "required": [
+        "parent_id",
+        "child_id"
+    ],
+    "additionalProperties": false
+};
+export const LixDirectoryDescriptorSchema = {
+    "x-lix-key": "lix_directory_descriptor",
+    "x-lix-version": "1",
+    "x-lix-primary-key": [
+        "/id"
+    ],
+    "x-lix-unique": [
+        [
+            "/parent_id",
+            "/name"
+        ]
+    ],
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "x-lix-default": "lix_uuid_v7()"
+        },
+        "parent_id": {
+            "type": [
+                "string",
+                "null"
+            ]
+        },
+        "name": {
+            "type": "string",
+            "pattern": "^(?!\\.{1,2}$)[^/\\\\]+$"
+        },
+        "hidden": {
+            "type": "boolean",
+            "x-lix-default": "false"
+        }
+    },
+    "required": [
+        "id",
+        "parent_id",
+        "name"
+    ],
+    "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"
+    ],
+    "x-lix-unique": [
+        [
+            "/directory_id",
+            "/name",
+            "/extension"
+        ]
+    ],
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "x-lix-default": "lix_uuid_v7()"
+        },
+        "directory_id": {
+            "type": [
+                "string",
+                "null"
+            ]
+        },
+        "name": {
+            "type": "string",
+            "pattern": "^[^/\\\\]+$"
+        },
+        "extension": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "pattern": "^[^./\\\\]+$"
+        },
+        "hidden": {
+            "type": "boolean",
+            "x-lix-default": "false"
+        }
+    },
+    "required": [
+        "id",
+        "directory_id",
+        "name",
+        "extension"
+    ],
+    "additionalProperties": false
+};
+export const LixKeyValueSchema = {
+    "x-lix-key": "lix_key_value",
+    "x-lix-version": "1",
+    "x-lix-primary-key": [
+        "/key"
+    ],
+    "type": "object",
+    "properties": {
+        "key": {
+            "type": "string"
+        },
+        "value": {
+            "description": "Arbitrary JSON value. This field stays in the JSON domain even when different rows hold different JSON kinds.",
+            "anyOf": [
+                {
+                    "type": "object"
+                },
+                {
+                    "type": "array"
+                },
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "number"
+                },
+                {
+                    "type": "boolean"
+                },
+                {
+                    "type": "null"
+                }
+            ]
+        }
+    },
+    "required": [
+        "key",
+        "value"
+    ],
+    "additionalProperties": false
+};
+export const LixLabelSchema = {
+    "x-lix-key": "lix_label",
+    "x-lix-version": "1",
+    "x-lix-primary-key": [
+        "/id"
+    ],
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "x-lix-default": "lix_uuid_v7()"
+        },
+        "name": {
+            "type": "string"
+        }
+    },
+    "required": [
+        "id",
+        "name"
+    ],
+    "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"
+    ],
+    "type": "object",
+    "properties": {
+        "value": {
+            "type": "object",
+            "properties": {
+                "x-lix-key": {
+                    "type": "string"
+                },
+                "x-lix-version": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "x-lix-key",
+                "x-lix-version"
+            ],
+            "additionalProperties": true
+        }
+    },
+    "required": [
+        "value"
+    ],
+    "additionalProperties": false
+};
+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"
+    ],
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "x-lix-default": "lix_uuid_v7()",
+            "description": "Stable version identifier (UUIDv7). Referenced by `lix_version_ref.id` and `lix_active_version.version_id`."
+        },
+        "name": {
+            "type": "string",
+            "description": "Human-readable version name (e.g. `main`, `feature-x`) shown in version listings and CLI output."
+        },
+        "hidden": {
+            "type": "boolean",
+            "default": false,
+            "description": "When true, the version is filtered from default listings (CLI, catalog views); operations by explicit id still succeed."
+        }
+    },
+    "required": [
+        "id",
+        "name"
+    ],
+    "additionalProperties": false
+};
+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"
+    ],
+    "x-lix-foreign-keys": [
+        {
+            "properties": [
+                "/commit_id"
+            ],
+            "references": {
+                "schemaKey": "lix_commit",
+                "properties": [
+                    "/id"
+                ]
+            }
+        }
+    ],
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "x-lix-default": "lix_uuid_v7()",
+            "description": "Version identifier whose head pointer is being stored; matches `lix_version_descriptor.id`."
+        },
+        "commit_id": {
+            "type": "string",
+            "description": "Commit the version should currently resolve to in the local runtime (references `lix_commit.id`)."
+        }
+    },
+    "required": [
+        "id",
+        "commit_id"
+    ],
+    "additionalProperties": false
+};