@inlang/sdk 0.22.0 → 0.24.0

package/README.md

@@ -2,12 +2,12 @@ Developer-first localization infrastructure that is built on git. Your git repos
 
 <div>
     <p align="center">
-        <img width="300" src="https://cdn.jsdelivr.net/gh/inlang/monorepo/inlang/assets/logo-white-background.png"/>
+        <img width="300" src="https://cdn.jsdelivr.net/gh/opral/monorepo/inlang/assets/logo-white-background.png"/>
     </p>
     <h4 align="center">
         <!-- <a href="https://inlang.com/documentation" target="_blank">Get Started</a>
         ·  -->
-        <a href="https://github.com/inlang/monorepo/discussions" target="_blank">Discussions</a> · <a href="https://twitter.com/inlangHQ" target="_blank">Twitter</a>
+        <a href="https://github.com/opral/monorepo/discussions" target="_blank">Discussions</a> · <a href="https://twitter.com/inlangHQ" target="_blank">Twitter</a>
     </h4>
 </div>
 

package/dist/adapter/solidAdapter.test.js

@@ -4,6 +4,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";
 // ------------------------------------------------------------------------------------------------
 const config = {
     sourceLanguageTag: "en",
@@ -74,9 +75,10 @@ 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 });
         let counter = 0;
@@ -98,9 +100,10 @@ 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 });
         let counterPlugins = 0;
@@ -151,9 +154,10 @@ describe("messages", () => {
         const mockImport = async () => ({ default: mockPlugin });
         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 });
         let counter = 0;
@@ -172,9 +176,10 @@ 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 });
         let counter = 0;
@@ -218,9 +223,10 @@ 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 });
             let counter = 0;
@@ -245,9 +251,10 @@ 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 });
             let counter = 0;

package/dist/createNodeishFsWithWatcher.js

@@ -24,7 +24,7 @@ export const createNodeishFsWithWatcher = (args) => {
             catch (err) {
                 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/dist/env-variables/index.d.ts

@@ -0,0 +1,4 @@
+export declare const ENV_VARIABLES: {
+    PUBLIC_POSTHOG_TOKEN: string;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/env-variables/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/env-variables/index.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,aAAa;;CAEzB,CAAA"}

package/dist/env-variables/index.js

@@ -0,0 +1,3 @@
+export const ENV_VARIABLES = {
+    PUBLIC_POSTHOG_TOKEN: "phc_m5yJZCxjOGxF8CJvP5sQ3H0d76xpnLrsmiZHduT4jDz",
+};

package/dist/listProjects.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"listProjects.d.ts","sourceRoot":"","sources":["../src/listProjects.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAEnD,eAAO,MAAM,YAAY,cACb,iBAAiB,QACtB,MAAM,KACV,QAAQ,MAAM;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC,CAiCxC,CAAA"}
+{"version":3,"file":"listProjects.d.ts","sourceRoot":"","sources":["../src/listProjects.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAEnD,eAAO,MAAM,YAAY,cACb,iBAAiB,QACtB,MAAM,KACV,QAAQ,MAAM;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC,CAwCxC,CAAA"}

package/dist/listProjects.js

@@ -9,17 +9,23 @@ export const listProjects = async (nodeishFs, from) => {
         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;
+            }
         }
     }
     await searchDir(from, 0);

package/dist/listProjects.test.js

@@ -1,6 +1,9 @@
-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 { mockRepo } from "@lix-js/client";
+// eslint-disable-next-line no-restricted-imports -- test
+import { readFileSync } from "node:fs";
 const settings = {
     sourceLanguageTag: "en",
     languageTags: ["en"],
@@ -43,6 +46,16 @@ describe("listProjects", () => {
             assert(projects.length === 0);
         });
     });
+    it("should not crash on broken symlinks as cal.com has", async () => {
+        const ciTestRepo = 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/dist/loadProject.d.ts

@@ -1,23 +1,42 @@
 import type { InlangProject, Subscribable } from "./api.js";
 import { type ImportFunction } from "./resolve-modules/index.js";
-import { type NodeishFilesystem } from "@lix-js/fs";
 import type { Repository } from "@lix-js/client";
 /**
  * Creates an inlang instance.
  *
  * @param projectPath - Absolute path to the inlang settings file.
- * @param nodeishFs - Filesystem that implements the NodeishFilesystemSubset interface.
+ * @param @deprecated 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 declare const loadProject: (args: {
+export declare function loadProject(args: {
     projectPath: string;
-    repo?: Repository | undefined;
-    nodeishFs: NodeishFilesystem;
-    _import?: ImportFunction | undefined;
-    _capture?: ((id: string, props: Record<string, unknown>) => void) | undefined;
-}) => Promise<InlangProject>;
+    nodeishFs: Repository["nodeishFs"];
+    /**
+     * The app id is used to identify the app that is using the SDK.
+     *
+     * We use the app id to group events in telemetry to answer questions
+     * like "Which apps causes these errors?" or "Which apps are used more than others?".
+     *
+     * @example
+     * 	appId: "app.inlang.badge"
+     */
+    appId?: string;
+    _import?: ImportFunction;
+}): Promise<InlangProject>;
+/**
+ * @param projectPath - Absolute path to the inlang settings file.
+ * @param repo - An instance of a lix repo as returned by `openRepository`.
+ * @param _import - Use `_import` to pass a custom import function for testing,
+ *   and supporting legacy resolvedModules such as CJS.
+ *
+ */
+export declare function loadProject(args: {
+    projectPath: string;
+    repo: Repository;
+    appId?: string;
+    _import?: ImportFunction;
+}): Promise<InlangProject>;
 export declare function createSubscribable<T>(signal: () => T): Subscribable<T>;
 //# sourceMappingURL=loadProject.d.ts.map

package/dist/loadProject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"loadProject.d.ts","sourceRoot":"","sources":["../src/loadProject.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,aAAa,EAGb,YAAY,EACZ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,KAAK,cAAc,EAAkB,MAAM,4BAA4B,CAAA;AAkBhF,OAAO,EAAiB,KAAK,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAIlE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAKhD;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW;iBACV,MAAM;;eAER,iBAAiB;;qBAEZ,MAAM,SAAS,OAAO,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI;MAC5D,QAAQ,aAAa,CAkQxB,CAAA;AAwHD,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAQtE"}
+{"version":3,"file":"loadProject.d.ts","sourceRoot":"","sources":["../src/loadProject.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACX,aAAa,EAGb,YAAY,EACZ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,KAAK,cAAc,EAAkB,MAAM,4BAA4B,CAAA;AAuBhF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAKhD;;;;;;;;GAQG;AACH,wBAAsB,WAAW,CAAC,IAAI,EAAE;IACvC,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,UAAU,CAAC,WAAW,CAAC,CAAA;IAClC;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,cAAc,CAAA;CACxB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA;AAE1B;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,IAAI,EAAE;IACvC,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,UAAU,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,cAAc,CAAA;CACxB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA;AA+Y1B,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAQtE"}

package/dist/loadProject.js

@@ -13,22 +13,11 @@ import { normalizePath } from "@lix-js/fs";
 import { isAbsolutePath } from "./isAbsolutePath.js";
 import { createNodeishFsWithWatcher } from "./createNodeishFsWithWatcher.js";
 import { maybeMigrateToDirectory } from "./migrations/migrateToDirectory.js";
-import { generateProjectId } from "./generateProjectId.js";
+import { maybeCreateFirstProjectId } from "./migrations/maybeCreateFirstProjectId.js";
+import { capture } from "./telemetry/capture.js";
 const settingsCompiler = TypeCompiler.Compile(ProjectSettings);
-/**
- * Creates an inlang instance.
- *
- * @param projectPath - 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) => {
+export async function loadProject(args) {
     const projectPath = normalizePath(args.projectPath);
-    // -- migrate if outdated ------------------------------------------------
-    await maybeMigrateToDirectory({ nodeishFs: args.nodeishFs, projectPath });
     // -- validation --------------------------------------------------------
     // the only place where throwing is acceptable because the project
     // won't even be loaded. do not throw anywhere else. otherwise, apps
@@ -39,34 +28,31 @@ export const loadProject = async (args) => {
     else if (/[^\\/]+\.inlang$/.test(projectPath) === false) {
         throw new LoadProjectInvalidArgument(`Expected a path ending in "{name}.inlang" but received "${projectPath}".\n\nValid examples: \n- "/path/to/micky-mouse.inlang"\n- "/path/to/green-elephant.inlang\n`, { argument: "projectPath" });
     }
+    let fs;
+    if (args.nodeishFs) {
+        // TODO: deprecate
+        fs = args.nodeishFs;
+    }
+    else if (args.repo) {
+        fs = args.repo.nodeishFs;
+    }
+    else {
+        throw new LoadProjectInvalidArgument(`Repo missing from arguments.`, { argument: "repo" });
+    }
+    const nodeishFs = createNodeishFsWithAbsolutePaths({
+        projectPath,
+        nodeishFs: fs,
+    });
+    // -- migratations ------------------------------------------------
+    await maybeMigrateToDirectory({ nodeishFs: fs, projectPath });
+    await maybeCreateFirstProjectId({ projectPath, repo: args.repo });
     // -- load project ------------------------------------------------------
-    let idError;
     return await createRoot(async () => {
+        // TODO remove tryCatch after https://github.com/opral/monorepo/issues/2013
+        // - a repo will always be present
+        // - if a repo is present, the project id will always be present
+        const { data: projectId } = await tryCatch(() => fs.readFile(args.projectPath + "/project_id", { encoding: "utf-8" }));
         const [initialized, markInitAsComplete, markInitAsFailed] = createAwaitable();
-        const nodeishFs = createNodeishFsWithAbsolutePaths({
-            projectPath,
-            nodeishFs: args.nodeishFs,
-        });
-        let projectId;
-        try {
-            projectId = await nodeishFs.readFile(projectPath + "/project_id", {
-                encoding: "utf-8",
-            });
-        }
-        catch (error) {
-            // @ts-ignore
-            if (error.code === "ENOENT") {
-                if (args.repo) {
-                    projectId = await generateProjectId(args.repo, projectPath);
-                    if (projectId) {
-                        await nodeishFs.writeFile(projectPath + "/project_id", projectId);
-                    }
-                }
-            }
-            else {
-                idError = error;
-            }
-        }
         // -- settings ------------------------------------------------------------
         const [settings, _setSettings] = createSignal();
         createEffect(() => {
@@ -77,12 +63,7 @@ export const loadProject = async (args) => {
             // 	})
             // }
             loadSettings({ settingsFilePath: projectPath + "/settings.json", nodeishFs })
-                .then((settings) => {
-                setSettings(settings);
-                // rename settings to get a convenient access to the data in Posthog
-                const project_settings = settings;
-                args._capture?.("SDK used settings", { project_settings, group: projectId });
-            })
+                .then((settings) => setSettings(settings))
                 .catch((err) => {
                 markInitAsFailed(err);
             });
@@ -158,7 +139,7 @@ export const loadProject = async (args) => {
                 description: rule.description,
                 module: resolvedModules()?.meta.find((m) => m.id.includes(rule.id))?.module ??
                     "Unknown module. You stumbled on a bug in inlang's source code. Please open an issue.",
-                // default to warning, see https://github.com/inlang/monorepo/issues/1254
+                // default to warning, see https://github.com/opral/monorepo/issues/1254
                 level: settingsValue["messageLintRuleLevels"]?.[rule.id] ?? "warning",
             }));
         };
@@ -203,6 +184,27 @@ export const loadProject = async (args) => {
         createEffect(() => {
             debouncedSave(messagesQuery.getAll());
         });
+        /**
+         * Utility to escape reactive tracking and avoid multiple calls to
+         * the capture event.
+         *
+         * Should be addressed with https://github.com/opral/monorepo/issues/1772
+         */
+        let projectLoadedCapturedAlready = false;
+        if (projectId && projectLoadedCapturedAlready === false) {
+            projectLoadedCapturedAlready = true;
+            // TODO ensure that capture is "awaited" without blocking the the app from starting
+            await capture("SDK loaded project", {
+                projectId,
+                properties: {
+                    appId: args.appId,
+                    settings: settings(),
+                    installedPluginIds: installedPlugins().map((p) => p.id),
+                    installedMessageLintRuleIds: installedMessageLintRules().map((r) => r.id),
+                    numberOfMessages: messagesQuery.includedMessageIds().length,
+                },
+            });
+        }
         return {
             installed: {
                 plugins: createSubscribable(() => installedPlugins()),
@@ -210,10 +212,7 @@ export const loadProject = async (args) => {
             },
             errors: createSubscribable(() => [
                 ...(initializeError ? [initializeError] : []),
-                ...(idError ? [idError] : []),
                 ...(resolvedModules() ? resolvedModules().errors : []),
-                // have a query error exposed
-                //...(lintErrors() ?? []),
             ]),
             settings: createSubscribable(() => settings()),
             setSettings,
@@ -224,7 +223,7 @@ export const loadProject = async (args) => {
             },
         };
     });
-};
+}
 //const x = {} as InlangProject
 // ------------------------------------------------------------------------------------------------
 const loadSettings = async (args) => {