Merge pull request #3298 from opral/lixdk-253-non-nullable-version-na…

…me-with-default-human-id

adds unique and default human readable version names

.changeset/nine-seahorses-love.md

@@ -0,0 +1,8 @@
+---
+"@lix-js/sdk": minor
+---
+
+adds unique and default human readable version names
+
+- removes nullability of `version.name` which eases conditional logic. 
+- apps don't need custom default version naming logic anymore

packages/csv-app/package.json

@@ -18,7 +18,6 @@
 		"@shoelace-style/shoelace": "^2.17.1",
 		"@xyflow/react": "^12.3.4",
 		"clsx": "^2.1.1",
-		"human-id": "^4.1.1",
 		"jotai": "^2.10.1",
 		"lodash-es": "^4.17.21",
 		"native-file-system-adapter": "^3.0.1",

packages/csv-app/src/layouts/OpenFileLayout.tsx

@@ -29,7 +29,6 @@ import {
 	switchVersion,
 	mergeVersion,
 } from "@lix-js/sdk";
-import { humanId } from "human-id";
 import CustomLink from "../components/CustomLink.tsx";
 
 export default function Layout(props: { children: React.ReactNode }) {
@@ -277,11 +276,6 @@ const VersionDropdown = () => {
 						const newversion = await createVersion({
 							lix,
 							from: currentVersion,
-							name: humanId({
-								separator: "-",
-								capitalize: false,
-								adjectiveCount: 0,
-							}),
 						});
 						await switchToversion(newversion);
 					}}

packages/lix-file-manager/package.json

@@ -31,7 +31,6 @@
 		"class-variance-authority": "^0.7.0",
 		"clsx": "^2.1.1",
 		"date-fns": "^2.29.3",
-		"human-id": "^4.1.1",
 		"jotai": "^2.10.1",
 		"lodash-es": "^4.17.21",
 		"lucide-react": "^0.460.0",

packages/lix-file-manager/src/components/VersionDropdown.tsx

@@ -23,7 +23,6 @@ import {
 } from "../state.js";
 import { Version, createVersion, switchVersion } from "@lix-js/sdk";
 import { saveLixToOpfs } from "../helper/saveLixToOpfs.js";
-import { humanId } from "human-id";
 import { Check, Trash2, ChevronDown, Plus } from "lucide-react";
 import { MergeDialog } from "./MergeDialog.js";
 import IconMerge from "./icons/IconMerge.js";
@@ -56,11 +55,6 @@ export function VersionDropdown() {
 		const newVersion = await createVersion({
 			lix,
 			from: currentVersion,
-			name: humanId({
-				separator: "-",
-				capitalize: false,
-				adjectiveCount: 0,
-			}),
 		});
 
 		await switchToVersion(newVersion);

packages/lix-file-manager/src/components/ui/form.tsx

@@ -15,7 +15,7 @@ import { cn } from "@/lib/utils"
 // @ts-expect-error - no types
 import { Label } from "@/components/ui/label"
 
-const Form = FormProvider
+const Form: any = FormProvider;
 
 type FormFieldContextValue<
   TFieldValues extends FieldValues = FieldValues,

packages/lix-sdk/src/database/apply-schema.ts

@@ -201,14 +201,7 @@ export function applySchema(args: { sqlite: SqliteDatabase }): SqliteDatabase {
   CREATE TABLE IF NOT EXISTS version (
     id TEXT PRIMARY KEY DEFAULT (uuid_v7()),
 
-    -- name is optional. 
-    -- 
-    -- "anonymous" versiones can ease workflows. 
-    -- For example, a user can create a version 
-    -- without a name to experiment with
-    -- changes with no mental overhead of 
-    -- naming the version.
-    name TEXT
+    name TEXT NOT NULL UNIQUE DEFAULT (human_id())
   ) STRICT;
 
   CREATE TABLE IF NOT EXISTS version_change (

packages/lix-sdk/src/database/init-db.test.ts

@@ -524,3 +524,17 @@ test("version_change must have a unique entity_id, file_id, version_id, and sche
 		.values({ ...versionChange, version_id: version1.id })
 		.execute();
 });
+
+test("versions have a unique and default human readable name", async () => {
+	const lix = await openLixInMemory({});
+
+	const version0 = await createVersion({ lix });
+	const version1 = await createVersion({ lix });
+
+	expect(version0.name).not.toBe(version1.name);
+
+	await expect(
+		createVersion({ lix, name: version0.name }),
+		"version.name is unique"
+	).rejects.toThrow();
+});

packages/lix-sdk/src/database/init-db.ts

@@ -9,6 +9,7 @@ import { ParseJsonBPluginV1 } from "./kysely-plugin/parse-jsonb-plugin-v1.js";
 import { SerializeJsonBPlugin } from "./kysely-plugin/serialize-jsonb-plugin.js";
 import { createSession } from "./mutation-log/lix-session.js";
 import { applyOwnChangeControlTriggers } from "../own-change-control/database-triggers.js";
+import { humanId } from "human-id";
 
 export function initDb(args: {
 	sqlite: SqliteDatabase;
@@ -91,4 +92,10 @@ function initFunctions(args: { sqlite: SqliteDatabase }) {
 		arity: 0,
 		xFunc: () => lixSession.sessionClockTick(),
 	});
+
+	args.sqlite.createFunction({
+		name: "human_id",
+		arity: 0,
+		xFunc: () => humanId({ separator: "-", capitalize: false }),
+	});
 }

packages/lix-sdk/src/database/schema.ts

@@ -202,7 +202,7 @@ export type Newversion = Insertable<VersionTable>;
 export type VersionUpdate = Updateable<VersionTable>;
 type VersionTable = {
 	id: Generated<string>;
-	name: string | null;
+	name: Generated<string>;
 };
 
 export type VersionChange = Selectable<VersionChangeTable>;

packages/lix-sdk/src/file-queue/file-queue-process.ts

@@ -27,7 +27,6 @@ export async function initFileQueueProcess(args: {
 	let hasMoreEntriesSince: number | undefined = undefined;
 
 	async function queueWorker(trail = false) {
-
 		if (args.lix.sqlite.isOpen() === false) {
 			console.log("sqlite is closed");
 			return;

packages/lix-website-server/src/main.ts

@@ -81,9 +81,10 @@ app.use(express.static(`${node_modules}/lix-website/build/client`));
 // Serve the website server routes
 app.all(
   "*",
+  // @ts-ignore
   createRequestHandler({
     build: require(`${node_modules}/lix-website/build/server`),
-  }),
+  })
 );
 
 // Start the server