@inlang/sdk 0.22.0 → 0.24.0

package/src/adapter/solidAdapter.test.ts

@@ -5,6 +5,7 @@ import { createEffect, from, createRoot } from "../reactivity/solid.js"
 import { solidAdapter } from "./solidAdapter.js"
 import { loadProject } from "../loadProject.js"
 import { createNodeishMemoryFs } from "@lix-js/fs"
+import { openRepository } from "@lix-js/client"
 import type {
 	Message,
 	ProjectSettings,
@@ -92,10 +93,11 @@ describe("config", () => {
 		const fs = createNodeishMemoryFs()
 		await fs.mkdir("/user/project.inlang", { recursive: true })
 		await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(config))
+		const repo = await openRepository("file://", { nodeishFs: fs })
 		const project = solidAdapter(
 			await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import: $import,
 			}),
 			{ from }
@@ -125,10 +127,11 @@ describe("installed", () => {
 		const fs = createNodeishMemoryFs()
 		await fs.mkdir("/user/project.inlang", { recursive: true })
 		await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(config))
+		const repo = await openRepository("file://", { nodeishFs: fs })
 		const project = solidAdapter(
 			await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import: $import,
 			}),
 			{ from }
@@ -190,10 +193,11 @@ describe("messages", () => {
 
 		await fs.mkdir("/user/project.inlang.inlang", { recursive: true })
 		await fs.writeFile("/user/project.inlang.inlang/settings.json", JSON.stringify(mockConfig))
+		const repo = await openRepository("file://", { nodeishFs: fs })
 		const project = solidAdapter(
 			await loadProject({
 				projectPath: "/user/project.inlang.inlang",
-				nodeishFs: fs,
+				repo,
 				_import: mockImport,
 			}),
 			{ from }
@@ -220,10 +224,11 @@ describe("messages", () => {
 		const fs = createNodeishMemoryFs()
 		await fs.mkdir("/user/project.inlang.inlang", { recursive: true })
 		await fs.writeFile("/user/project.inlang.inlang/settings.json", JSON.stringify(config))
+		const repo = await openRepository("file://", { nodeishFs: fs })
 		const project = solidAdapter(
 			await loadProject({
 				projectPath: "/user/project.inlang.inlang",
-				nodeishFs: fs,
+				repo,
 				_import: $import,
 			}),
 			{ from }
@@ -282,10 +287,11 @@ describe("lint", () => {
 			const fs = createNodeishMemoryFs()
 			await fs.mkdir("./project.inlang", { recursive: true })
 			await fs.writeFile("./project.inlang/settings.json", JSON.stringify(config))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 			const project = solidAdapter(
 				await loadProject({
 					projectPath: "./project.inlang",
-					nodeishFs: fs,
+					repo,
 					_import: $import,
 				}),
 				{ from }
@@ -320,10 +326,11 @@ describe("lint", () => {
 		await createRoot(async () => {
 			const fs = createNodeishMemoryFs()
 			await fs.writeFile("./project.config.json", JSON.stringify(config))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 			const project = solidAdapter(
 				await loadProject({
 					projectPath: "./project.config.json",
-					nodeishFs: fs,
+					repo,
 					_import: $import,
 				}),
 				{ from }

package/src/createNodeishFsWithWatcher.ts

@@ -28,7 +28,7 @@ export const createNodeishFsWithWatcher = (args: {
 				}
 			} catch (err: any) {
 				if (err.name === "AbortError") return
-				// https://github.com/inlang/monorepo/issues/1647
+				// https://github.com/opral/monorepo/issues/1647
 				// the file does not exist (yet)
 				// this is not testable beacause the fs.watch api differs
 				// from node and lix. lenghty

package/src/env-variables/.prettierignore

@@ -0,0 +1 @@
+index.js

package/src/env-variables/createIndexFile.js

@@ -0,0 +1,28 @@
+/* eslint-disable no-restricted-imports */
+/* 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))
+
+await fs.writeFile(
+	dirname + "/index.ts",
+	`
+export const ENV_VARIABLES = {
+  PUBLIC_POSTHOG_TOKEN: "${process.env.PUBLIC_POSTHOG_TOKEN}",
+}
+`
+)
+
+// eslint-disable-next-line no-console
+console.log("✅ Created env variable index file.")

package/src/env-variables/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Avoiding TypeScript errors before the `createIndexFile` script
+ * is invoked by defining the type ahead of time.
+ */
+
+/**
+ * Env variables that are available at runtime.
+ *
+ * - assume that each env variable might be undefined (to ease development/contributions)
+ */
+export declare const ENV_VARIABLES: Partial<{
+	PUBLIC_POSTHOG_TOKEN: string
+}>

package/src/listProjects.test.ts

@@ -1,7 +1,10 @@
-import { assert, describe, it } from "vitest"
+import { assert, describe, it, expect } from "vitest"
 import { listProjects } from "./listProjects.js"
-import { createNodeishMemoryFs } from "@lix-js/fs"
+import { createNodeishMemoryFs, type Snapshot } from "@lix-js/fs"
 import type { ProjectSettings } from "@inlang/project-settings"
+import { mockRepo } from "@lix-js/client"
+// eslint-disable-next-line no-restricted-imports -- test
+import { readFileSync } from "node:fs"
 
 const settings: ProjectSettings = {
 	sourceLanguageTag: "en",
@@ -55,6 +58,22 @@ describe("listProjects", () => {
 		})
 	})
 
+	it("should not crash on broken symlinks as cal.com has", async () => {
+		const ciTestRepo: Snapshot = JSON.parse(
+			readFileSync("./mocks/ci-test-repo-no-shallow.json", { encoding: "utf-8" })
+		)
+		const repo = await mockRepo({ fromSnapshot: ciTestRepo })
+		repo.checkout({ branch: "test-symlink" })
+
+		const link = await repo.nodeishFs.readlink("test-symlink-not-existing-target")
+
+		expect(link).toBe("/test-symlink-not-existing-target//.././no-exist")
+
+		await listProjects(repo.nodeishFs, "/").then((projects) => {
+			assert(projects.length === 1)
+		})
+	})
+
 	it("should also find files inside of a dir that ends with *.inlang", async () => {
 		const fs = createNodeishMemoryFs()
 		await fs.mkdir("/user/dir1/go.inlang", { recursive: true })

package/src/listProjects.ts

@@ -17,14 +17,21 @@ export const listProjects = async (
 		const files = await nodeishFs.readdir(path)
 		for (const file of files) {
 			const filePath = `${path}/${file}`
-			const stats = await nodeishFs.stat(filePath)
-			if (stats.isDirectory()) {
-				if (file === "node_modules") continue
-				if (file.endsWith(".inlang")) {
-					projects.push({ projectPath: filePath })
-				} else {
-					await searchDir(filePath, depth + 1)
+			try {
+				const stats = await nodeishFs.stat(filePath)
+				if (stats.isDirectory()) {
+					if (file === "node_modules") {
+						continue
+					}
+
+					if (file.endsWith(".inlang")) {
+						projects.push({ projectPath: filePath })
+					} else {
+						await searchDir(filePath, depth + 1)
+					}
 				}
+			} catch {
+				continue
 			}
 		}
 	}

package/src/loadProject.test.ts

@@ -19,7 +19,12 @@ import {
 import { createNodeishMemoryFs, normalizePath } from "@lix-js/fs"
 import { createMessage } from "./test-utilities/createMessage.js"
 import { tryCatch } from "@inlang/result"
-import { mockRepo } from "@lix-js/client"
+import { mockRepo, openRepository } from "@lix-js/client"
+import { type Snapshot } from "@lix-js/fs"
+// eslint-disable-next-line no-restricted-imports -- test
+import { readFileSync } from "node:fs"
+// eslint-disable-next-line no-restricted-imports -- test
+import { resolve } from "node:path"
 
 // ------------------------------------------------------------------------------------------------
 
@@ -104,6 +109,16 @@ const _import: ImportFunction = async (name) =>
 		default: name === "plugin.js" ? mockPlugin : mockMessageLintRule,
 	} satisfies InlangModule)
 
+async function openCiTestRepo() {
+	return await mockRepo({
+		fromSnapshot: JSON.parse(
+			readFileSync(resolve(__dirname, "../mocks/ci-test-repo-no-shallow.json"), {
+				encoding: "utf-8",
+			})
+		) as Snapshot,
+	})
+}
+
 // ------------------------------------------------------------------------------------------------
 
 /**
@@ -114,10 +129,11 @@ const _import: ImportFunction = async (name) =>
  */
 it("should throw if a project (path) does not have a name", async () => {
 	const fs = createNodeishMemoryFs()
+	const repo = await openRepository("file://", { nodeishFs: fs })
 	const project = await tryCatch(() =>
 		loadProject({
 			projectPath: "/source-code/.inlang",
-			nodeishFs: fs,
+			repo,
 			_import,
 		})
 	)
@@ -126,6 +142,7 @@ it("should throw if a project (path) does not have a name", async () => {
 
 it("should throw if a project path does not end with .inlang", async () => {
 	const fs = createNodeishMemoryFs()
+	const repo = await openRepository("file://", { nodeishFs: fs })
 
 	const invalidPaths = [
 		"/source-code/frontend.inlang/settings",
@@ -137,7 +154,7 @@ it("should throw if a project path does not end with .inlang", async () => {
 		const project = await tryCatch(() =>
 			loadProject({
 				projectPath: invalidPath,
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 		)
@@ -148,11 +165,12 @@ it("should throw if a project path does not end with .inlang", async () => {
 describe("initialization", () => {
 	it("should throw if projectPath is not an absolute path", async () => {
 		const fs = createNodeishMemoryFs()
+		const repo = await openRepository("file://", { nodeishFs: fs })
 
 		const result = await tryCatch(() =>
 			loadProject({
 				projectPath: "relative/path",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 		)
@@ -161,7 +179,7 @@ describe("initialization", () => {
 	})
 
 	it("should generate projectId on missing projectid", async () => {
-		const repo = await mockRepo()
+		const repo = await openCiTestRepo()
 
 		const existing = await repo.nodeishFs
 			.readFile("/project.inlang/project_id", {
@@ -177,7 +195,6 @@ describe("initialization", () => {
 		const result = await tryCatch(() =>
 			loadProject({
 				projectPath: "/project.inlang",
-				nodeishFs: repo.nodeishFs,
 				repo,
 				_import,
 			})
@@ -191,21 +208,20 @@ describe("initialization", () => {
 				return { error }
 			})
 
-		expect(newId).toBe("7cd6c2b7cf12febf99496408917123fdfe158b6bc442914f5fb42aa74346bd50")
+		expect(newId).toBe("aef225403be8b526dfb492a4617fd59d8181e8fef2c7f4aff56ab299046e36ed")
 
 		expect(result.error).toBeUndefined()
 		expect(result.data).toBeDefined()
 	})
 
 	it("should reuse projectId on existing projectid", async () => {
-		const repo = await mockRepo()
+		const repo = await openCiTestRepo()
 
 		repo.nodeishFs.writeFile("/project.inlang/project_id", "testId")
 
 		const result = await tryCatch(() =>
 			loadProject({
 				projectPath: "/project.inlang",
-				nodeishFs: repo.nodeishFs,
 				repo,
 				_import,
 			})
@@ -229,11 +245,12 @@ describe("initialization", () => {
 		const fs = createNodeishMemoryFs()
 		fs.mkdir("C:\\Users\\user\\project.inlang", { recursive: true })
 		fs.writeFile("C:\\Users\\user\\project.inlang\\settings.json", JSON.stringify(settings))
+		const repo = await openRepository("file://", { nodeishFs: fs })
 
 		const result = await tryCatch(() =>
 			loadProject({
 				projectPath: "C:\\Users\\user\\project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 		)
@@ -246,10 +263,11 @@ describe("initialization", () => {
 		it("should return an error if settings file is not found", async () => {
 			const fs = createNodeishMemoryFs()
 			fs.mkdir("/user/project", { recursive: true })
+			const repo = await openRepository("file://", { nodeishFs: fs })
 
 			const project = await loadProject({
 				projectPath: "/user/non-existend-project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -260,10 +278,11 @@ describe("initialization", () => {
 			const fs = await createNodeishMemoryFs()
 			await fs.mkdir("/user/project.inlang", { recursive: true })
 			await fs.writeFile("/user/project.inlang/settings.json", "invalid json")
+			const repo = await openRepository("file://", { nodeishFs: fs })
 
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -274,10 +293,11 @@ describe("initialization", () => {
 			const fs = await createNodeishMemoryFs()
 			await fs.mkdir("/user/project.inlang", { recursive: true })
 			await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify({}))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -288,9 +308,10 @@ describe("initialization", () => {
 			const fs = await createNodeishMemoryFs()
 			await fs.mkdir("/user/project.inlang", { recursive: true })
 			await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(settings))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -302,10 +323,11 @@ describe("initialization", () => {
 			const settingsWithDeifferentFormatting = JSON.stringify(settings, undefined, 4)
 			await fs.mkdir("/user/project.inlang", { recursive: true })
 			await fs.writeFile("/user/project.inlang/settings.json", settingsWithDeifferentFormatting)
+			const repo = await openRepository("file://", { nodeishFs: fs })
 
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -335,10 +357,11 @@ describe("initialization", () => {
 			const fs = createNodeishMemoryFs()
 			await fs.mkdir("/user/project.inlang", { recursive: true })
 			await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(settings))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import: $badImport,
 			})
 
@@ -368,9 +391,10 @@ describe("functionality", () => {
 			const fs = await createNodeishMemoryFs()
 			await fs.mkdir("/user/project.inlang", { recursive: true })
 			await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(settings))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -381,9 +405,10 @@ describe("functionality", () => {
 			const fs = await createNodeishMemoryFs()
 			await fs.mkdir("/user/project.inlang", { recursive: true })
 			await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(settings))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -407,9 +432,10 @@ describe("functionality", () => {
 			const fs = await createNodeishMemoryFs()
 			await fs.mkdir("/user/project.inlang", { recursive: true })
 			await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(settings))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -429,10 +455,11 @@ describe("functionality", () => {
 			}
 
 			await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(settings))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -444,9 +471,10 @@ describe("functionality", () => {
 			const fs = await createNodeishMemoryFs()
 			await fs.mkdir("/user/project.inlang", { recursive: true })
 			await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(settings))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -476,9 +504,10 @@ describe("functionality", () => {
 			}
 			await fs.mkdir("/user/project.inlang", { recursive: true })
 			await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(settings))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -509,10 +538,11 @@ describe("functionality", () => {
 
 			await fs.mkdir("/user/project.inlang", { recursive: true })
 			await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(settings))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -551,6 +581,7 @@ describe("functionality", () => {
 					modules: ["plugin.js", "lintRule.js"],
 				} satisfies ProjectSettings)
 			)
+			const repo = await openRepository("file://", { nodeishFs: fs })
 
 			const _import: ImportFunction = async (name) => {
 				return {
@@ -559,7 +590,7 @@ describe("functionality", () => {
 			}
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -602,6 +633,7 @@ describe("functionality", () => {
 					modules: ["plugin.js", "lintRule.js"],
 				} satisfies ProjectSettings)
 			)
+			const repo = await openRepository("file://", { nodeishFs: fs })
 			const _import: ImportFunction = async (name) => {
 				return {
 					default: name === "plugin.js" ? _mockPlugin : _mockLintRule,
@@ -610,7 +642,7 @@ describe("functionality", () => {
 
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -627,9 +659,10 @@ describe("functionality", () => {
 			const fs = await createNodeishMemoryFs()
 			await fs.mkdir("/user/project.inlang", { recursive: true })
 			await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(settings))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 			project.errors.subscribe((errors) => {
@@ -643,9 +676,10 @@ describe("functionality", () => {
 			const fs = await createNodeishMemoryFs()
 			await fs.mkdir("/user/project.inlang", { recursive: true })
 			await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(settings))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -660,9 +694,10 @@ describe("functionality", () => {
 			const fs = await createNodeishMemoryFs()
 			await fs.mkdir("/user/project.inlang", { recursive: true })
 			await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(settings))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -687,6 +722,7 @@ describe("functionality", () => {
 			await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(settings))
 
 			await fs.mkdir("./resources")
+			const repo = await openRepository("file://", { nodeishFs: fs })
 
 			const mockSaveFn = vi.fn()
 
@@ -707,7 +743,7 @@ describe("functionality", () => {
 
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -862,6 +898,7 @@ describe("functionality", () => {
 
 			await fs.mkdir("./project.inlang", { recursive: true })
 			await fs.writeFile("./project.inlang/settings.json", JSON.stringify(settings))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 
 			const mockSaveFn = vi.fn()
 
@@ -886,7 +923,7 @@ describe("functionality", () => {
 
 			const project = await loadProject({
 				projectPath: "/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 
@@ -904,9 +941,10 @@ describe("functionality", () => {
 			const fs = await createNodeishMemoryFs()
 			await fs.mkdir("/user/project", { recursive: true })
 			await fs.writeFile("/user/project/project.inlang.json", JSON.stringify(settings))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 			const project = await loadProject({
 				projectPath: "/user/project/project.inlang.json",
-				nodeishFs: fs,
+				repo,
 				_import,
 			})
 			// TODO: test with real lint rules
@@ -926,9 +964,10 @@ describe("functionality", () => {
 			const fs = createNodeishMemoryFs()
 			await fs.mkdir("/user/project.inlang", { recursive: true })
 			await fs.writeFile("/user/project.inlang/settings.json", JSON.stringify(settings))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 			const project = await loadProject({
 				projectPath: "/user/project.inlang",
-				nodeishFs: fs,
+				repo,
 				_import: async () => ({
 					default: mockMessageLintRule,
 				}),
@@ -991,11 +1030,12 @@ describe("functionality", () => {
 
 			await fs.mkdir("./project.inlang", { recursive: true })
 			await fs.writeFile("./project.inlang/settings.json", JSON.stringify(settings))
+			const repo = await openRepository("file://", { nodeishFs: fs })
 
 			// establish watcher
 			const project = await loadProject({
 				projectPath: normalizePath("/project.inlang"),
-				nodeishFs: fs,
+				repo,
 				_import: async () => ({
 					default: mockMessageFormatPlugin,
 				}),