@inlang/sdk 0.10.0 → 0.12.0

package/src/loadProject.ts

@@ -13,6 +13,7 @@ import {
 	ProjectSettingsInvalidError,
 	PluginLoadMessagesError,
 	PluginSaveMessagesError,
+	LoadProjectInvalidArgument,
 } from "./errors.js"
 import { createRoot, createSignal, createEffect } from "./reactivity/solid.js"
 import { createMessagesQuery } from "./createMessagesQuery.js"
@@ -21,14 +22,21 @@ import { createMessageLintReportsQuery } from "./createMessageLintReportsQuery.j
 import { ProjectSettings, Message, type NodeishFilesystemSubset } from "./versionedInterfaces.js"
 import { tryCatch, type Result } from "@inlang/result"
 import { migrateIfOutdated } from "@inlang/project-settings/migration"
+import {
+	createNodeishFsWithAbsolutePaths,
+	isAbsolutePath,
+} from "./createNodeishFsWithAbsolutePaths.js"
 
 const settingsCompiler = TypeCompiler.Compile(ProjectSettings)
 
 /**
  * Creates an inlang instance.
  *
- * - Use `_import` to pass a custom import function for testing,
+ * @param settingsFilePath - Absolute path to the inlang settings file.
+ * @param nodeishFs - Filesystem that implements the NodeishFilesystemSubset interface.
+ * @param _import - Use `_import` to pass a custom import function for testing,
  *   and supporting legacy resolvedModules such as CJS.
+ * @param _capture - Use `_capture` to capture events for analytics.
  *
  */
 export const loadProject = async (args: {
@@ -37,14 +45,27 @@ export const loadProject = async (args: {
 	_import?: ImportFunction
 	_capture?: (id: string, props: Record<string, unknown>) => void
 }): Promise<InlangProject> => {
+	// -- validation --------------------------------------------------------
+	//! the only place where throwing is acceptable because the project
+	//! won't even be loaded. do not throw anywhere else. otherwise, apps
+	//! can't handle errors gracefully.
+	if (!isAbsolutePath(args.settingsFilePath)) {
+		throw new LoadProjectInvalidArgument(
+			`Expected an absolute path but received "${args.settingsFilePath}".`,
+			{ argument: "settingsFilePath" }
+		)
+	}
+
+	// -- load project ------------------------------------------------------
 	return await createRoot(async () => {
 		const [initialized, markInitAsComplete, markInitAsFailed] = createAwaitable()
+		const nodeishFs = createNodeishFsWithAbsolutePaths(args)
 
 		// -- settings ------------------------------------------------------------
 
 		const [settings, _setSettings] = createSignal<ProjectSettings>()
 		createEffect(() => {
-			loadSettings({ settingsFilePath: args.settingsFilePath, nodeishFs: args.nodeishFs })
+			loadSettings({ settingsFilePath: args.settingsFilePath, nodeishFs })
 				.then((settings) => {
 					setSettings(settings)
 					// rename settings to get a convenient access to the data in Posthog
@@ -58,7 +79,7 @@ export const loadProject = async (args: {
 		// TODO: create FS watcher and update settings on change
 
 		const writeSettingsToDisk = skipFirst((settings: ProjectSettings) =>
-			_writeSettingsToDisk({ nodeishFs: args.nodeishFs, settings })
+			_writeSettingsToDisk({ nodeishFs, settings })
 		)
 
 		const setSettings = (settings: ProjectSettings): Result<void, ProjectSettingsInvalidError> => {
@@ -88,7 +109,7 @@ export const loadProject = async (args: {
 			const _settings = settings()
 			if (!_settings) return
 
-			resolveModules({ settings: _settings, nodeishFs: args.nodeishFs, _import: args._import })
+			resolveModules({ settings: _settings, nodeishFs, _import: args._import })
 				.then((resolvedModules) => {
 					setResolvedModules(resolvedModules)
 				})

package/src/resolve-modules/import.ts

@@ -1,5 +1,4 @@
 import dedent from "dedent"
-import { normalizePath } from "@lix-js/fs"
 import type { NodeishFilesystemSubset } from "@inlang/plugin"
 import { ModuleImportError } from "./errors.js"
 
@@ -42,7 +41,9 @@ async function $import(
 	if (uri.startsWith("http")) {
 		moduleAsText = await (await fetch(uri)).text()
 	} else {
-		moduleAsText = await options.readFile(normalizePath(uri), { encoding: "utf-8" })
+		moduleAsText = await options.readFile(uri, {
+			encoding: "utf-8",
+		})
 	}
 
 	const moduleWithMimeType = "data:application/javascript," + encodeURIComponent(moduleAsText)

package/src/resolve-modules/plugins/types.ts

@@ -1,4 +1,4 @@
-import type { NodeishFilesystem as LisaNodeishFilesystem } from "@lix-js/fs"
+import type { NodeishFilesystem } from "@lix-js/fs"
 import type {
 	PluginReturnedInvalidCustomApiError,
 	PluginLoadMessagesFunctionAlreadyDefinedError,
@@ -18,7 +18,7 @@ import type { ProjectSettings } from "@inlang/project-settings"
  * - only uses minimally required functions to decrease the API footprint on the ecosystem.
  */
 export type NodeishFilesystemSubset = Pick<
-	LisaNodeishFilesystem,
+	NodeishFilesystem,
 	"readFile" | "readdir" | "mkdir" | "writeFile"
 >