@inlang/sdk 0.22.0 → 0.23.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/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) => {

package/dist/loadProject.test.js

@@ -6,6 +6,9 @@ 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 {} from "@lix-js/fs";
+// eslint-disable-next-line no-restricted-imports -- test
+import { readFileSync } from "node:fs";
 // ------------------------------------------------------------------------------------------------
 const getValue = (subscribable) => {
     let value;
@@ -124,7 +127,8 @@ describe("initialization", () => {
         expect(result.data).toBeUndefined();
     });
     it("should generate projectId on missing projectid", async () => {
-        const repo = await mockRepo();
+        const ciTestRepo = JSON.parse(readFileSync("./mocks/ci-test-repo-no-shallow.json", { encoding: "utf-8" }));
+        const repo = await mockRepo({ fromSnapshot: ciTestRepo });
         const existing = await repo.nodeishFs
             .readFile("/project.inlang/project_id", {
             encoding: "utf-8",
@@ -136,7 +140,6 @@ describe("initialization", () => {
         expect(existing.error.code).toBe("ENOENT");
         const result = await tryCatch(() => loadProject({
             projectPath: "/project.inlang",
-            nodeishFs: repo.nodeishFs,
             repo,
             _import,
         }));
@@ -147,16 +150,16 @@ describe("initialization", () => {
             .catch((error) => {
             return { error };
         });
-        expect(newId).toBe("7cd6c2b7cf12febf99496408917123fdfe158b6bc442914f5fb42aa74346bd50");
+        expect(newId).toBe("e8c61726bc2f437ec6a260abb632b3c59195059b60031e648b5afbafa7f3d79a");
         expect(result.error).toBeUndefined();
         expect(result.data).toBeDefined();
     });
     it("should reuse projectId on existing projectid", async () => {
-        const repo = await mockRepo();
+        const ciTestRepo = JSON.parse(readFileSync("./mocks/ci-test-repo-no-shallow.json", { encoding: "utf-8" }));
+        const repo = await mockRepo({ fromSnapshot: ciTestRepo });
         repo.nodeishFs.writeFile("/project.inlang/project_id", "testId");
         const result = await tryCatch(() => loadProject({
             projectPath: "/project.inlang",
-            nodeishFs: repo.nodeishFs,
             repo,
             _import,
         }));

package/dist/migrations/maybeCreateFirstProjectId.d.ts

@@ -0,0 +1,16 @@
+import type { Repository } from "@lix-js/client";
+/**
+ * Creates a project id if it does not exist yet.
+ *
+ * - this is a migration to ensure that all projects have a project id
+ * - new projects are created with a project id (in the future)
+ */
+export declare function maybeCreateFirstProjectId(args: {
+    projectPath: string;
+    repo?: Repository;
+}): Promise<void>;
+export declare function generateProjectId(args: {
+    repo?: Repository;
+    projectPath: string;
+}): Promise<string | undefined>;
+//# sourceMappingURL=maybeCreateFirstProjectId.d.ts.map

package/dist/migrations/maybeCreateFirstProjectId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"maybeCreateFirstProjectId.d.ts","sourceRoot":"","sources":["../../src/migrations/maybeCreateFirstProjectId.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAGhD;;;;;GAKG;AACH,wBAAsB,yBAAyB,CAAC,IAAI,EAAE;IACrD,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,UAAU,CAAA;CACjB,GAAG,OAAO,CAAC,IAAI,CAAC,CAkBhB;AAED,wBAAsB,iBAAiB,CAAC,IAAI,EAAE;IAAE,IAAI,CAAC,EAAE,UAAU,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,+BAWvF"}

package/dist/migrations/maybeCreateFirstProjectId.js

@@ -0,0 +1,38 @@
+import { hash } from "@lix-js/client";
+/**
+ * Creates a project id if it does not exist yet.
+ *
+ * - this is a migration to ensure that all projects have a project id
+ * - new projects are created with a project id (in the future)
+ */
+export async function maybeCreateFirstProjectId(args) {
+    // the migration assumes a repository
+    if (args.repo === undefined) {
+        return;
+    }
+    try {
+        await args.repo.nodeishFs.readFile(args.projectPath + "/project_id", {
+            encoding: "utf-8",
+        });
+    }
+    catch (error) {
+        // @ts-ignore
+        if (error.code === "ENOENT" && args.repo) {
+            const projectId = await generateProjectId({ repo: args.repo, projectPath: args.projectPath });
+            if (projectId) {
+                await args.repo.nodeishFs.writeFile(args.projectPath + "/project_id", projectId);
+            }
+        }
+    }
+}
+export async function generateProjectId(args) {
+    if (!args.repo || !args.projectPath) {
+        return undefined;
+    }
+    const firstCommitHash = await args.repo.getFirstCommitHash();
+    const originHash = await args.repo.getOrigin({ safeHashOnly: true });
+    if (firstCommitHash) {
+        return hash(`${firstCommitHash + args.projectPath + originHash}`);
+    }
+    return undefined;
+}

package/dist/migrations/maybeCreateFirstProjectId.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=maybeCreateFirstProjectId.test.d.ts.map

package/dist/migrations/maybeCreateFirstProjectId.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"maybeCreateFirstProjectId.test.d.ts","sourceRoot":"","sources":["../../src/migrations/maybeCreateFirstProjectId.test.ts"],"names":[],"mappings":""}

package/dist/migrations/maybeCreateFirstProjectId.test.js

@@ -0,0 +1,27 @@
+import { generateProjectId } from "./maybeCreateFirstProjectId.js";
+import { it, expect } from "vitest";
+import { openRepository } from "@lix-js/client/src/openRepository.ts";
+import { mockRepo, createNodeishMemoryFs } from "@lix-js/client";
+import {} from "@lix-js/fs";
+// eslint-disable-next-line no-restricted-imports -- test
+import { readFileSync } from "node:fs";
+const ciTestRepo = JSON.parse(readFileSync("./mocks/ci-test-repo-no-shallow.json", { encoding: "utf-8" }));
+const repo = await mockRepo({ fromSnapshot: ciTestRepo });
+it("should return if repo is undefined", async () => {
+    const projectId = await generateProjectId({ repo: undefined, projectPath: "mocked_project_path" });
+    expect(projectId).toBeUndefined();
+});
+it("should generate a project id", async () => {
+    const projectId = await generateProjectId({ repo, projectPath: "mocked_project_path" });
+    expect(projectId).toBe("959bcf0a30e678c9b90a3c76d1a281d085eab55f289c5439b6b10849baa1920c");
+});
+it("should return undefined if repoMeta contains error", async () => {
+    const repoWithError = await openRepository("https://github.com/inlang/no-exist", {
+        nodeishFs: createNodeishMemoryFs(),
+    });
+    const projectId = await generateProjectId({
+        repo: repoWithError,
+        projectPath: "mocked_project_path",
+    });
+    expect(projectId).toBeUndefined();
+});

package/dist/migrations/migrateToDirectory.d.ts

@@ -1,7 +1,7 @@
 import type { NodeishFilesystem } from "@lix-js/fs";
 /**
  * Migrates to the new project directory structure
- * https://github.com/inlang/monorepo/issues/1678
+ * https://github.com/opral/monorepo/issues/1678
  */
 export declare const maybeMigrateToDirectory: (args: {
     nodeishFs: NodeishFilesystem;

package/dist/migrations/migrateToDirectory.js

@@ -1,7 +1,7 @@
 import { tryCatch } from "@inlang/result";
 /**
  * Migrates to the new project directory structure
- * https://github.com/inlang/monorepo/issues/1678
+ * https://github.com/opral/monorepo/issues/1678
  */
 export const maybeMigrateToDirectory = async (args) => {
     // the migration assumes that the projectPath ends with project.inlang
@@ -38,9 +38,9 @@ The \`project.inlang.json\` file is now contained in a project directory e.g. \`
 ## Why is this happening?
 
 See this RFC https://docs.google.com/document/d/1OYyA1wYfQRbIJOIBDliYoWjiUlkFBNxH_U2R4WpVRZ4/edit#heading=h.pecv6xb7ial6 
-and the following GitHub issue for more information https://github.com/inlang/monorepo/issues/1678.
+and the following GitHub issue for more information https://github.com/opral/monorepo/issues/1678.
 
-- Monorepo support https://github.com/inlang/monorepo/discussions/258. 
+- Monorepo support https://github.com/opral/monorepo/discussions/258. 
 - Required for many other future features like caching, first class offline support, and more. 
 - Stablize the inlang project format.
 `;

package/dist/telemetry/capture.d.ts

@@ -0,0 +1,21 @@
+/**
+ * List of telemetry events for typesafety.
+ *
+ * - prefix with `SDK` to avoid collisions with other apps
+ * - use past tense to indicate that the event is completed
+ */
+declare const events: readonly ["SDK loaded project"];
+/**
+ * Capture an event.
+ *
+ * - manually calling the PostHog API because the SDKs were not platform angostic (and generally bloated)
+ */
+export declare const capture: (event: (typeof events)[number], args: {
+    projectId: string;
+    /**
+     * Please use snake_case for property names.
+     */
+    properties: Record<string, any>;
+}) => Promise<void>;
+export {};
+//# sourceMappingURL=capture.d.ts.map

package/dist/telemetry/capture.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"capture.d.ts","sourceRoot":"","sources":["../../src/telemetry/capture.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,QAAA,MAAM,MAAM,iCAAkC,CAAA;AAE9C;;;;GAIG;AACH,eAAO,MAAM,OAAO,UACZ,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,QACxB;IACL,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,UAAU,EAAE,OAAO,MAAM,EAAE,GAAG,CAAC,CAAA;CAC/B,kBAyBD,CAAA"}

package/dist/telemetry/capture.js

@@ -0,0 +1,39 @@
+import { ENV_VARIABLES } from "../env-variables/index.js";
+/**
+ * List of telemetry events for typesafety.
+ *
+ * - prefix with `SDK` to avoid collisions with other apps
+ * - use past tense to indicate that the event is completed
+ */
+const events = ["SDK loaded project"];
+/**
+ * Capture an event.
+ *
+ * - manually calling the PostHog API because the SDKs were not platform angostic (and generally bloated)
+ */
+export const capture = async (event, args) => {
+    // do not send events if the token is not set
+    // (assuming this eases testing)
+    if (ENV_VARIABLES.PUBLIC_POSTHOG_TOKEN === undefined) {
+        return;
+    }
+    try {
+        await fetch("https://eu.posthog.com/capture/", {
+            method: "POST",
+            body: JSON.stringify({
+                api_key: ENV_VARIABLES.PUBLIC_POSTHOG_TOKEN,
+                event,
+                // id is "unknown" because no user information is available
+                distinct_id: "unknown",
+                properties: {
+                    $groups: { project: args.projectId },
+                    ...args.properties,
+                },
+            }),
+        });
+    }
+    catch (e) {
+        // TODO implement sentry logging
+        // do not console.log and avoid exposing internal errors to the user
+    }
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@inlang/sdk",
   "type": "module",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public"
@@ -26,16 +26,16 @@
     "solid-js": "1.6.12",
     "throttle-debounce": "^5.0.0",
     "@inlang/json-types": "1.1.0",
-    "@inlang/language-tag": "1.3.0",
-    "@inlang/message-lint-rule": "1.4.0",
-    "@inlang/message": "2.0.0",
-    "@inlang/module": "1.2.1",
-    "@inlang/plugin": "2.4.1",
-    "@inlang/project-settings": "2.2.0",
-    "@inlang/result": "1.1.0",
-    "@inlang/translatable": "1.2.0",
+    "@inlang/language-tag": "1.4.0",
+    "@inlang/message": "2.0.1",
+    "@inlang/message-lint-rule": "1.4.1",
+    "@inlang/module": "1.2.2",
+    "@inlang/plugin": "2.4.2",
+    "@inlang/project-settings": "2.2.1",
+    "@inlang/translatable": "1.2.1",
+    "@lix-js/fs": "0.5.0",
     "@lix-js/client": "0.5.0",
-    "@lix-js/fs": "0.5.0"
+    "@inlang/result": "1.1.0"
   },
   "devDependencies": {
     "@types/throttle-debounce": "5.0.0",
@@ -47,8 +47,9 @@
     "vitest": "^0.33.0"
   },
   "scripts": {
-    "build": "tsc --build",
-    "dev": "tsc --watch",
+    "build": "npm run prepare-env-variables && tsc --build",
+    "dev": "npm run prepare-env-variables && tsc --watch",
+    "prepare-env-variables": "node ./src/env-variables/createIndexFile.js",
     "test": "tsc --noEmit && vitest run --passWithNoTests --coverage",
     "lint": "eslint ./src --fix",
     "format": "prettier ./src --write",

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

@@ -20,6 +20,9 @@ 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 { type Snapshot } from "@lix-js/fs"
+// eslint-disable-next-line no-restricted-imports -- test
+import { readFileSync } from "node:fs"
 
 // ------------------------------------------------------------------------------------------------
 
@@ -161,7 +164,10 @@ describe("initialization", () => {
 	})
 
 	it("should generate projectId on missing projectid", async () => {
-		const repo = await mockRepo()
+		const ciTestRepo: Snapshot = JSON.parse(
+			readFileSync("./mocks/ci-test-repo-no-shallow.json", { encoding: "utf-8" })
+		)
+		const repo = await mockRepo({ fromSnapshot: ciTestRepo })
 
 		const existing = await repo.nodeishFs
 			.readFile("/project.inlang/project_id", {
@@ -177,7 +183,6 @@ describe("initialization", () => {
 		const result = await tryCatch(() =>
 			loadProject({
 				projectPath: "/project.inlang",
-				nodeishFs: repo.nodeishFs,
 				repo,
 				_import,
 			})
@@ -191,21 +196,23 @@ describe("initialization", () => {
 				return { error }
 			})
 
-		expect(newId).toBe("7cd6c2b7cf12febf99496408917123fdfe158b6bc442914f5fb42aa74346bd50")
+		expect(newId).toBe("e8c61726bc2f437ec6a260abb632b3c59195059b60031e648b5afbafa7f3d79a")
 
 		expect(result.error).toBeUndefined()
 		expect(result.data).toBeDefined()
 	})
 
 	it("should reuse projectId on existing projectid", async () => {
-		const repo = await mockRepo()
+		const ciTestRepo: Snapshot = JSON.parse(
+			readFileSync("./mocks/ci-test-repo-no-shallow.json", { encoding: "utf-8" })
+		)
+		const repo = await mockRepo({ fromSnapshot: ciTestRepo })
 
 		repo.nodeishFs.writeFile("/project.inlang/project_id", "testId")
 
 		const result = await tryCatch(() =>
 			loadProject({
 				projectPath: "/project.inlang",
-				nodeishFs: repo.nodeishFs,
 				repo,
 				_import,
 			})

package/src/loadProject.ts

@@ -23,12 +23,13 @@ import { ProjectSettings, Message, type NodeishFilesystemSubset } from "./versio
 import { tryCatch, type Result } from "@inlang/result"
 import { migrateIfOutdated } from "@inlang/project-settings/migration"
 import { createNodeishFsWithAbsolutePaths } from "./createNodeishFsWithAbsolutePaths.js"
-import { normalizePath, type NodeishFilesystem } from "@lix-js/fs"
+import { normalizePath } from "@lix-js/fs"
 import { isAbsolutePath } from "./isAbsolutePath.js"
 import { createNodeishFsWithWatcher } from "./createNodeishFsWithWatcher.js"
 import { maybeMigrateToDirectory } from "./migrations/migrateToDirectory.js"
+import { maybeCreateFirstProjectId } from "./migrations/maybeCreateFirstProjectId.js"
 import type { Repository } from "@lix-js/client"
-import { generateProjectId } from "./generateProjectId.js"
+import { capture } from "./telemetry/capture.js"
 
 const settingsCompiler = TypeCompiler.Compile(ProjectSettings)
 
@@ -36,24 +37,49 @@ 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 @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 const loadProject = async (args: {
+export async function loadProject(args: {
 	projectPath: string
-	repo?: Repository
-	nodeishFs: NodeishFilesystem
+	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
-	_capture?: (id: string, props: Record<string, unknown>) => void
-}): Promise<InlangProject> => {
-	const projectPath = normalizePath(args.projectPath)
+}): Promise<InlangProject>
 
-	// -- migrate if outdated ------------------------------------------------
+/**
+ * @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 async function loadProject(args: {
+	projectPath: string
+	repo: Repository
+	appId?: string
+	_import?: ImportFunction
+}): Promise<InlangProject>
 
-	await maybeMigrateToDirectory({ nodeishFs: args.nodeishFs, projectPath })
+export async function loadProject(args: {
+	projectPath: string
+	repo?: Repository
+	appId?: string
+	_import?: ImportFunction
+	nodeishFs?: Repository["nodeishFs"]
+}): Promise<InlangProject> {
+	const projectPath = normalizePath(args.projectPath)
 
 	// -- validation --------------------------------------------------------
 	// the only place where throwing is acceptable because the project
@@ -72,35 +98,37 @@ export const loadProject = async (args: {
 		)
 	}
 
-	// -- load project ------------------------------------------------------
-	let idError: Error | undefined
-	return await createRoot(async () => {
-		const [initialized, markInitAsComplete, markInitAsFailed] = createAwaitable()
-		const nodeishFs = createNodeishFsWithAbsolutePaths({
-			projectPath,
-			nodeishFs: args.nodeishFs,
-		})
+	let fs: Repository["nodeishFs"]
+	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" })
+	}
 
-		let projectId: string | undefined
+	const nodeishFs = createNodeishFsWithAbsolutePaths({
+		projectPath,
+		nodeishFs: fs,
+	})
 
-		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 as Error
-			}
-		}
+	// -- migratations ------------------------------------------------
+
+	await maybeMigrateToDirectory({ nodeishFs: fs, projectPath })
+	await maybeCreateFirstProjectId({ projectPath, repo: args.repo })
+
+	// -- load project ------------------------------------------------------
 
+	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()
 		// -- settings ------------------------------------------------------------
 
 		const [settings, _setSettings] = createSignal<ProjectSettings>()
@@ -113,12 +141,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)
 				})
@@ -218,7 +241,7 @@ export const loadProject = async (args: {
 						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",
 					} satisfies InstalledMessageLintRule)
 			) satisfies Array<InstalledMessageLintRule>
@@ -285,6 +308,29 @@ export const loadProject = async (args: {
 			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()),
@@ -292,10 +338,7 @@ export const loadProject = async (args: {
 			},
 			errors: createSubscribable(() => [
 				...(initializeError ? [initializeError] : []),
-				...(idError ? [idError] : []),
 				...(resolvedModules() ? resolvedModules()!.errors : []),
-				// have a query error exposed
-				//...(lintErrors() ?? []),
 			]),
 			settings: createSubscribable(() => settings() as ProjectSettings),
 			setSettings,

package/src/migrations/maybeCreateFirstProjectId.test.ts

@@ -0,0 +1,34 @@
+import { generateProjectId } from "./maybeCreateFirstProjectId.js"
+import { it, expect } from "vitest"
+import { openRepository } from "@lix-js/client/src/openRepository.ts"
+import { mockRepo, createNodeishMemoryFs } from "@lix-js/client"
+import { type Snapshot } from "@lix-js/fs"
+// eslint-disable-next-line no-restricted-imports -- test
+import { readFileSync } from "node:fs"
+
+const ciTestRepo: Snapshot = JSON.parse(
+	readFileSync("./mocks/ci-test-repo-no-shallow.json", { encoding: "utf-8" })
+)
+const repo = await mockRepo({ fromSnapshot: ciTestRepo as Snapshot })
+
+it("should return if repo is undefined", async () => {
+	const projectId = await generateProjectId({ repo: undefined, projectPath: "mocked_project_path" })
+	expect(projectId).toBeUndefined()
+})
+
+it("should generate a project id", async () => {
+	const projectId = await generateProjectId({ repo, projectPath: "mocked_project_path" })
+	expect(projectId).toBe("959bcf0a30e678c9b90a3c76d1a281d085eab55f289c5439b6b10849baa1920c")
+})
+
+it("should return undefined if repoMeta contains error", async () => {
+	const repoWithError = await openRepository("https://github.com/inlang/no-exist", {
+		nodeishFs: createNodeishMemoryFs(),
+	})
+
+	const projectId = await generateProjectId({
+		repo: repoWithError,
+		projectPath: "mocked_project_path",
+	})
+	expect(projectId).toBeUndefined()
+})

package/src/migrations/maybeCreateFirstProjectId.ts

@@ -0,0 +1,44 @@
+import type { Repository } from "@lix-js/client"
+import { hash } from "@lix-js/client"
+
+/**
+ * Creates a project id if it does not exist yet.
+ *
+ * - this is a migration to ensure that all projects have a project id
+ * - new projects are created with a project id (in the future)
+ */
+export async function maybeCreateFirstProjectId(args: {
+	projectPath: string
+	repo?: Repository
+}): Promise<void> {
+	// the migration assumes a repository
+	if (args.repo === undefined) {
+		return
+	}
+	try {
+		await args.repo.nodeishFs.readFile(args.projectPath + "/project_id", {
+			encoding: "utf-8",
+		})
+	} catch (error) {
+		// @ts-ignore
+		if (error.code === "ENOENT" && args.repo) {
+			const projectId = await generateProjectId({ repo: args.repo, projectPath: args.projectPath })
+			if (projectId) {
+				await args.repo.nodeishFs.writeFile(args.projectPath + "/project_id", projectId)
+			}
+		}
+	}
+}
+
+export async function generateProjectId(args: { repo?: Repository; projectPath: string }) {
+	if (!args.repo || !args.projectPath) {
+		return undefined
+	}
+	const firstCommitHash = await args.repo.getFirstCommitHash()
+	const originHash = await args.repo.getOrigin({ safeHashOnly: true })
+
+	if (firstCommitHash) {
+		return hash(`${firstCommitHash + args.projectPath + originHash}`)
+	}
+	return undefined
+}

package/src/migrations/migrateToDirectory.ts

@@ -3,7 +3,7 @@ import type { NodeishFilesystem } from "@lix-js/fs"
 
 /**
  * Migrates to the new project directory structure
- * https://github.com/inlang/monorepo/issues/1678
+ * https://github.com/opral/monorepo/issues/1678
  */
 export const maybeMigrateToDirectory = async (args: {
 	nodeishFs: NodeishFilesystem
@@ -51,9 +51,9 @@ The \`project.inlang.json\` file is now contained in a project directory e.g. \`
 ## Why is this happening?
 
 See this RFC https://docs.google.com/document/d/1OYyA1wYfQRbIJOIBDliYoWjiUlkFBNxH_U2R4WpVRZ4/edit#heading=h.pecv6xb7ial6 
-and the following GitHub issue for more information https://github.com/inlang/monorepo/issues/1678.
+and the following GitHub issue for more information https://github.com/opral/monorepo/issues/1678.
 
-- Monorepo support https://github.com/inlang/monorepo/discussions/258. 
+- Monorepo support https://github.com/opral/monorepo/discussions/258. 
 - Required for many other future features like caching, first class offline support, and more. 
 - Stablize the inlang project format.
 `

package/src/telemetry/capture.ts

@@ -0,0 +1,49 @@
+import { ENV_VARIABLES } from "../env-variables/index.js"
+
+/**
+ * List of telemetry events for typesafety.
+ *
+ * - prefix with `SDK` to avoid collisions with other apps
+ * - use past tense to indicate that the event is completed
+ */
+const events = ["SDK loaded project"] as const
+
+/**
+ * Capture an event.
+ *
+ * - manually calling the PostHog API because the SDKs were not platform angostic (and generally bloated)
+ */
+export const capture = async (
+	event: (typeof events)[number],
+	args: {
+		projectId: string
+		/**
+		 * Please use snake_case for property names.
+		 */
+		properties: Record<string, any>
+	}
+) => {
+	// do not send events if the token is not set
+	// (assuming this eases testing)
+	if (ENV_VARIABLES.PUBLIC_POSTHOG_TOKEN === undefined) {
+		return
+	}
+	try {
+		await fetch("https://eu.posthog.com/capture/", {
+			method: "POST",
+			body: JSON.stringify({
+				api_key: ENV_VARIABLES.PUBLIC_POSTHOG_TOKEN,
+				event,
+				// id is "unknown" because no user information is available
+				distinct_id: "unknown",
+				properties: {
+					$groups: { project: args.projectId },
+					...args.properties,
+				},
+			}),
+		})
+	} catch (e) {
+		// TODO implement sentry logging
+		// do not console.log and avoid exposing internal errors to the user
+	}
+}

package/dist/generateProjectId.d.ts

@@ -1,3 +0,0 @@
-import type { Repository } from "@lix-js/client";
-export declare function generateProjectId(repo: Repository, projectPath: string): Promise<string | undefined>;
-//# sourceMappingURL=generateProjectId.d.ts.map

package/dist/generateProjectId.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generateProjectId.d.ts","sourceRoot":"","sources":["../src/generateProjectId.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAGhD,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,+BAU5E"}

package/dist/generateProjectId.js

@@ -1,11 +0,0 @@
-import { hash } from "@lix-js/client";
-export async function generateProjectId(repo, projectPath) {
-    if (!repo || !projectPath) {
-        return undefined;
-    }
-    const repoMeta = await repo.getMeta();
-    if (repoMeta && !("error" in repoMeta)) {
-        return hash(`${repoMeta.id + projectPath}`);
-    }
-    return undefined;
-}

package/dist/generateProjectId.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=generateProjectId.test.d.ts.map

package/dist/generateProjectId.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generateProjectId.test.d.ts","sourceRoot":"","sources":["../src/generateProjectId.test.ts"],"names":[],"mappings":""}

package/dist/generateProjectId.test.js

@@ -1,18 +0,0 @@
-import { generateProjectId } from "./generateProjectId.js";
-import { describe, it, expect } from "vitest";
-import { openRepository } from "@lix-js/client/src/openRepository.ts";
-import { mockRepo, createNodeishMemoryFs } from "@lix-js/client";
-describe("generateProjectId", async () => {
-    const repo = await mockRepo();
-    it("should generate a project id", async () => {
-        const projectId = await generateProjectId(repo, "mocked_project_path");
-        expect(projectId).toBe("0c83325bf9068eb01091c522d4b8e3765aff42e36fc781c041b44439bbe3e734");
-    });
-    it("should return undefined if repoMeta contains error", async () => {
-        const errorRepo = await openRepository("https://github.com/inlang/no-exist", {
-            nodeishFs: createNodeishMemoryFs(),
-        });
-        const projectId = await generateProjectId(errorRepo, "mocked_project_path");
-        expect(projectId).toBeUndefined();
-    });
-});

package/src/generateProjectId.test.ts

@@ -1,22 +0,0 @@
-import { generateProjectId } from "./generateProjectId.js"
-import { describe, it, expect } from "vitest"
-import { openRepository } from "@lix-js/client/src/openRepository.ts"
-import { mockRepo, createNodeishMemoryFs } from "@lix-js/client"
-
-describe("generateProjectId", async () => {
-	const repo = await mockRepo()
-
-	it("should generate a project id", async () => {
-		const projectId = await generateProjectId(repo, "mocked_project_path")
-		expect(projectId).toBe("0c83325bf9068eb01091c522d4b8e3765aff42e36fc781c041b44439bbe3e734")
-	})
-
-	it("should return undefined if repoMeta contains error", async () => {
-		const errorRepo = await openRepository("https://github.com/inlang/no-exist", {
-			nodeishFs: createNodeishMemoryFs(),
-		})
-
-		const projectId = await generateProjectId(errorRepo, "mocked_project_path")
-		expect(projectId).toBeUndefined()
-	})
-})

package/src/generateProjectId.ts

@@ -1,14 +0,0 @@
-import type { Repository } from "@lix-js/client"
-import { hash } from "@lix-js/client"
-
-export async function generateProjectId(repo: Repository, projectPath: string) {
-	if (!repo || !projectPath) {
-		return undefined
-	}
-	const repoMeta = await repo.getMeta()
-
-	if (repoMeta && !("error" in repoMeta)) {
-		return hash(`${repoMeta.id + projectPath}`)
-	}
-	return undefined
-}