@inlang/sdk 0.34.8 → 0.34.9

package/dist/api.d.ts

@@ -48,7 +48,7 @@ export type InlangProject = {
 };
 /**
  * WIP template for async V2 crud interfaces
- * E.g. `project.messageBundles.get({ id: "..." })`
+ * E.g. `await project.messageBundles.get({ id: "..." })`
  **/
 interface Query<T> {
     get: (args: unknown) => Promise<T>;

package/dist/createMessageLintReportsQuery.d.ts

@@ -2,7 +2,11 @@ import type { InlangProject, InstalledMessageLintRule, MessageQueryApi } from ".
 import type { ProjectSettings } from "@inlang/project-settings";
 import type { resolveModules } from "./resolve-modules/index.js";
 /**
- * Creates a ~~reactive~~ query API for lint reports.
+ * Creates a non-reactive async query API for lint reports.
+ * e.g. used in editor/.../Listheader.tsx
+ *
+ * TODO MESDK-50: reactivity should be restored in future
+ * See https://github.com/opral/monorepo/pull/2378 for why this design.
  */
 export declare function createMessageLintReportsQuery(messagesQuery: MessageQueryApi, settings: () => ProjectSettings, installedMessageLintRules: () => Array<InstalledMessageLintRule>, resolvedModules: () => Awaited<ReturnType<typeof resolveModules>> | undefined): InlangProject["query"]["messageLintReports"];
 //# sourceMappingURL=createMessageLintReportsQuery.d.ts.map

package/dist/createMessageLintReportsQuery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createMessageLintReportsQuery.d.ts","sourceRoot":"","sources":["../src/createMessageLintReportsQuery.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,aAAa,EACb,wBAAwB,EAExB,eAAe,EAEf,MAAM,UAAU,CAAA;AACjB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAC/D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAQhE;;GAEG;AACH,wBAAgB,6BAA6B,CAC5C,aAAa,EAAE,eAAe,EAC9B,QAAQ,EAAE,MAAM,eAAe,EAC/B,yBAAyB,EAAE,MAAM,KAAK,CAAC,wBAAwB,CAAC,EAChE,eAAe,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,GAAG,SAAS,GAC3E,aAAa,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,CA6E9C"}
+{"version":3,"file":"createMessageLintReportsQuery.d.ts","sourceRoot":"","sources":["../src/createMessageLintReportsQuery.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,aAAa,EACb,wBAAwB,EAExB,eAAe,EAEf,MAAM,UAAU,CAAA;AACjB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAC/D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAWhE;;;;;;GAMG;AACH,wBAAgB,6BAA6B,CAC5C,aAAa,EAAE,eAAe,EAC9B,QAAQ,EAAE,MAAM,eAAe,EAC/B,yBAAyB,EAAE,MAAM,KAAK,CAAC,wBAAwB,CAAC,EAChE,eAAe,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,GAAG,SAAS,GAC3E,aAAa,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,CA8E9C"}

package/dist/createMessageLintReportsQuery.js

@@ -1,9 +1,15 @@
 import { lintSingleMessage } from "./lint/index.js";
+import _debug from "debug";
+const debug = _debug("sdk:lintReports");
 function sleep(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
 }
 /**
- * Creates a ~~reactive~~ query API for lint reports.
+ * Creates a non-reactive async query API for lint reports.
+ * e.g. used in editor/.../Listheader.tsx
+ *
+ * TODO MESDK-50: reactivity should be restored in future
+ * See https://github.com/opral/monorepo/pull/2378 for why this design.
  */
 export function createMessageLintReportsQuery(messagesQuery, settings, installedMessageLintRules, resolvedModules) {
     const index = new Map();
@@ -28,7 +34,7 @@ export function createMessageLintReportsQuery(messagesQuery, settings, installed
             message: message,
         }).then((report) => {
             if (report.errors.length === 0 && index.get(message.id) !== report.data) {
-                // console.log("lintSingleMessage", messageId, report.data.length)
+                debug("lintSingleMessage", message.id, report.data.length);
                 index.set(message.id, report.data);
             }
         });
@@ -63,10 +69,13 @@ export function createMessageLintReportsQuery(messagesQuery, settings, installed
     return {
         getAll: async () => {
             await sleep(0); // evaluate on next tick to allow for out-of-order effects
-            return structuredClone([...index.values()].flat().length === 0 ? [] : [...index.values()].flat());
+            const flatValues = [...index.values()].flat();
+            debug("getAll", flatValues.length);
+            return structuredClone(flatValues.length === 0 ? [] : flatValues);
         },
         get: async (args) => {
             await sleep(0); // evaluate on next tick to allow for out-of-order effects
+            debug("get", args.where.messageId);
             return structuredClone(index.get(args.where.messageId) ?? []);
         },
     };

package/dist/createMessagesQuery.js

@@ -9,7 +9,7 @@ import _debug from "debug";
 import { releaseLock } from "./persistence/filelock/releaseLock.js";
 import { PluginLoadMessagesError, PluginSaveMessagesError } from "./errors.js";
 import { humanIdHash } from "./storage/human-id/human-readable-id.js";
-const debug = _debug("sdk:createMessagesQuery");
+const debug = _debug("sdk:messages");
 function sleep(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
 }

package/dist/createNewProject.d.ts

@@ -3,11 +3,6 @@ import { ProjectSettings } from "@inlang/project-settings";
 /**
  * Creates a new project in the given directory.
  * The directory must be an absolute path, must not exist, and must end with {name}.inlang
- * Uses defaultProjectSettings unless projectSettings are provided.
- *
- * @param projectPath - Absolute path to the [name].inlang directory
- * @param repo - An instance of a lix repo as returned by `openRepository`
- * @param projectSettings - Optional project settings to use for the new project.
  */
 export declare function createNewProject(args: {
     projectPath: string;

package/dist/createNewProject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createNewProject.d.ts","sourceRoot":"","sources":["../src/createNewProject.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAI1D;;;;;;;;GAQG;AACH,wBAAsB,gBAAgB,CAAC,IAAI,EAAE;IAC5C,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,UAAU,CAAA;IAChB,eAAe,EAAE,eAAe,CAAA;CAChC,GAAG,OAAO,CAAC,IAAI,CAAC,CAYhB"}
+{"version":3,"file":"createNewProject.d.ts","sourceRoot":"","sources":["../src/createNewProject.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAI1D;;;GAGG;AACH,wBAAsB,gBAAgB,CAAC,IAAI,EAAE;IAC5C,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,UAAU,CAAA;IAChB,eAAe,EAAE,eAAe,CAAA;CAChC,GAAG,OAAO,CAAC,IAAI,CAAC,CAYhB"}

package/dist/createNewProject.js

@@ -4,11 +4,6 @@ import { defaultProjectSettings } from "./defaultProjectSettings.js";
 /**
  * Creates a new project in the given directory.
  * The directory must be an absolute path, must not exist, and must end with {name}.inlang
- * Uses defaultProjectSettings unless projectSettings are provided.
- *
- * @param projectPath - Absolute path to the [name].inlang directory
- * @param repo - An instance of a lix repo as returned by `openRepository`
- * @param projectSettings - Optional project settings to use for the new project.
  */
 export async function createNewProject(args) {
     assertValidProjectPath(args.projectPath);

package/dist/persistence/filelock/acquireFileLock.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"acquireFileLock.d.ts","sourceRoot":"","sources":["../../../src/persistence/filelock/acquireFileLock.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAQnD,wBAAsB,eAAe,CACpC,EAAE,EAAE,iBAAiB,EACrB,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,EAClB,QAAQ,GAAE,MAAU,GAClB,OAAO,CAAC,MAAM,CAAC,CA8GjB"}
+{"version":3,"file":"acquireFileLock.d.ts","sourceRoot":"","sources":["../../../src/persistence/filelock/acquireFileLock.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAQnD,wBAAsB,eAAe,CACpC,EAAE,EAAE,iBAAiB,EACrB,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,EAClB,QAAQ,GAAE,MAAU,GAClB,OAAO,CAAC,MAAM,CAAC,CAgHjB"}

package/dist/persistence/filelock/acquireFileLock.js

@@ -1,12 +1,12 @@
 import {} from "@lix-js/fs";
 import _debug from "debug";
-const debug = _debug("sdk:acquireFileLock");
+const debug = _debug("sdk:fileLock");
 const maxRetries = 10;
 const nProbes = 50;
 const probeInterval = 100;
 export async function acquireFileLock(fs, lockDirPath, lockOrigin, tryCount = 0) {
     if (tryCount > maxRetries) {
-        throw new Error(lockOrigin + " exceeded maximum Retries (5) to acquire lockfile " + tryCount);
+        throw new Error(`${lockOrigin} exceeded maximum retries (${maxRetries}) to acquire lockfile ${tryCount}`);
     }
     try {
         debug(lockOrigin + " tries to acquire a lockfile Retry Nr.: " + tryCount);

package/dist/persistence/filelock/releaseLock.js

@@ -1,6 +1,6 @@
 import {} from "@lix-js/fs";
 import _debug from "debug";
-const debug = _debug("sdk:releaseLock");
+const debug = _debug("sdk:fileLock");
 export async function releaseLock(fs, lockDirPath, lockOrigin, lockTime) {
     debug(lockOrigin + " releasing the lock ");
     try {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@inlang/sdk",
   "type": "module",
-  "version": "0.34.8",
+  "version": "0.34.9",
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public"
@@ -42,8 +42,8 @@
     "@inlang/project-settings": "2.4.2",
     "@inlang/result": "1.1.0",
     "@inlang/translatable": "1.3.1",
-    "@lix-js/fs": "1.0.0",
-    "@lix-js/client": "1.4.0"
+    "@lix-js/client": "1.4.0",
+    "@lix-js/fs": "1.0.0"
   },
   "devDependencies": {
     "@types/debug": "^4.1.12",

package/src/api.ts

@@ -65,7 +65,7 @@ export type InlangProject = {
 
 /**
  * WIP template for async V2 crud interfaces
- * E.g. `project.messageBundles.get({ id: "..." })`
+ * E.g. `await project.messageBundles.get({ id: "..." })`
  **/
 interface Query<T> {
 	get: (args: unknown) => Promise<T>

package/src/createMessageLintReportsQuery.ts

@@ -10,12 +10,19 @@ import type { resolveModules } from "./resolve-modules/index.js"
 import type { MessageLintReport, Message } from "./versionedInterfaces.js"
 import { lintSingleMessage } from "./lint/index.js"
 
+import _debug from "debug"
+const debug = _debug("sdk:lintReports")
+
 function sleep(ms: number) {
 	return new Promise((resolve) => setTimeout(resolve, ms))
 }
 
 /**
- * Creates a ~~reactive~~ query API for lint reports.
+ * Creates a non-reactive async query API for lint reports.
+ * e.g. used in editor/.../Listheader.tsx
+ *
+ * TODO MESDK-50: reactivity should be restored in future
+ * See https://github.com/opral/monorepo/pull/2378 for why this design.
  */
 export function createMessageLintReportsQuery(
 	messagesQuery: MessageQueryApi,
@@ -51,7 +58,7 @@ export function createMessageLintReportsQuery(
 			message: message,
 		}).then((report) => {
 			if (report.errors.length === 0 && index.get(message.id) !== report.data) {
-				// console.log("lintSingleMessage", messageId, report.data.length)
+				debug("lintSingleMessage", message.id, report.data.length)
 				index.set(message.id, report.data)
 			}
 		})
@@ -90,12 +97,13 @@ export function createMessageLintReportsQuery(
 	return {
 		getAll: async () => {
 			await sleep(0) // evaluate on next tick to allow for out-of-order effects
-			return structuredClone(
-				[...index.values()].flat().length === 0 ? [] : [...index.values()].flat()
-			)
+			const flatValues = [...index.values()].flat()
+			debug("getAll", flatValues.length)
+			return structuredClone(flatValues.length === 0 ? [] : flatValues)
 		},
 		get: async (args: Parameters<MessageLintReportsQueryApi["get"]>[0]) => {
 			await sleep(0) // evaluate on next tick to allow for out-of-order effects
+			debug("get", args.where.messageId)
 			return structuredClone(index.get(args.where.messageId) ?? [])
 		},
 	}

package/src/createMessagesQuery.ts

@@ -15,7 +15,7 @@ import type { ProjectSettings } from "@inlang/project-settings"
 import { releaseLock } from "./persistence/filelock/releaseLock.js"
 import { PluginLoadMessagesError, PluginSaveMessagesError } from "./errors.js"
 import { humanIdHash } from "./storage/human-id/human-readable-id.js"
-const debug = _debug("sdk:createMessagesQuery")
+const debug = _debug("sdk:messages")
 
 function sleep(ms: number) {
 	return new Promise((resolve) => setTimeout(resolve, ms))

package/src/createNewProject.ts

@@ -6,11 +6,6 @@ import { defaultProjectSettings } from "./defaultProjectSettings.js"
 /**
  * Creates a new project in the given directory.
  * The directory must be an absolute path, must not exist, and must end with {name}.inlang
- * Uses defaultProjectSettings unless projectSettings are provided.
- *
- * @param projectPath - Absolute path to the [name].inlang directory
- * @param repo - An instance of a lix repo as returned by `openRepository`
- * @param projectSettings - Optional project settings to use for the new project.
  */
 export async function createNewProject(args: {
 	projectPath: string

package/src/persistence/filelock/acquireFileLock.ts

@@ -1,7 +1,7 @@
 import { type NodeishFilesystem } from "@lix-js/fs"
 import type { NodeishStats } from "@lix-js/fs"
 import _debug from "debug"
-const debug = _debug("sdk:acquireFileLock")
+const debug = _debug("sdk:fileLock")
 
 const maxRetries = 10
 const nProbes = 50
@@ -13,7 +13,9 @@ export async function acquireFileLock(
 	tryCount: number = 0
 ): Promise<number> {
 	if (tryCount > maxRetries) {
-		throw new Error(lockOrigin + " exceeded maximum Retries (5) to acquire lockfile " + tryCount)
+		throw new Error(
+			`${lockOrigin} exceeded maximum retries (${maxRetries}) to acquire lockfile ${tryCount}`
+		)
 	}
 
 	try {

package/src/persistence/filelock/releaseLock.ts

@@ -1,6 +1,6 @@
 import { type NodeishFilesystem } from "@lix-js/fs"
 import _debug from "debug"
-const debug = _debug("sdk:releaseLock")
+const debug = _debug("sdk:fileLock")
 
 export async function releaseLock(
 	fs: NodeishFilesystem,