@inlang/sdk 0.36.2 → 2.0.0-prerelease.0

package/src/api.ts

@@ -1,116 +0,0 @@
-import type { Result } from "@inlang/result"
-import type * as RuntimeError from "./errors.js"
-import type * as ModuleResolutionError from "./resolve-modules/errors.js"
-import type {
-	MessageLintLevel,
-	MessageLintRule,
-	Message,
-	Plugin,
-	ProjectSettings,
-	MessageLintReport,
-} from "./versionedInterfaces.js"
-import type { ResolvedPluginApi } from "./resolve-modules/plugins/types.js"
-import type { StoreApi } from "./persistence/storeApi.js"
-
-export type InstalledPlugin = {
-	id: Plugin["id"]
-	displayName: Plugin["displayName"]
-	description: Plugin["description"]
-	/**
-	 * The module which the plugin is installed from.
-	 */
-	module: string
-	settingsSchema: Plugin["settingsSchema"]
-	// disabled: boolean
-}
-
-export type InstalledMessageLintRule = {
-	id: MessageLintRule["id"]
-	displayName: MessageLintRule["displayName"]
-	description: MessageLintRule["description"]
-	/**
-	 * The module which the lint rule is installed from.
-	 */
-	module: string
-	level: MessageLintLevel
-	settingsSchema: MessageLintRule["settingsSchema"]
-}
-
-export type InlangProject = {
-	/**
-	 * The project's id.
-	 */
-	// TODO #2063 make project id non-optional when every project is guaranteed to a project id
-	id?: string
-	installed: {
-		plugins: Subscribable<InstalledPlugin[]>
-		messageLintRules: Subscribable<InstalledMessageLintRule[]>
-	}
-	errors: Subscribable<
-		((typeof ModuleResolutionError)[keyof typeof ModuleResolutionError] | Error)[]
-	>
-	customApi: Subscribable<ResolvedPluginApi["customApi"]>
-	settings: Subscribable<ProjectSettings>
-	setSettings: (config: ProjectSettings) => Result<void, RuntimeError.ProjectSettingsInvalidError>
-	query: {
-		messages: MessageQueryApi
-		messageLintReports: MessageLintReportsQueryApi
-	}
-	// WIP V2 message apis
-	// use with project settings: experimental.persistence = true
-	store?: StoreApi
-}
-
-// const x = {} as InlangProject
-// const l = await x.lint()
-// x.lint.subscribe((m) => console.log(m))
-
-export type Subscribable<Value> = {
-	(): Value
-	subscribe: (callback: (value: Value) => void) => void
-}
-
-export type MessageQueryDelegate = {
-	onMessageCreate: (messageId: string, message: Message, messages: Message[]) => void
-	onMessageUpdate: (messageId: string, message: Message, messages: Message[]) => void
-	onMessageDelete: (messageId: string, messages: Message[]) => void
-	onLoaded: (messages: Message[]) => void
-	onCleanup: () => void
-}
-
-export type MessageQueryApi = {
-	create: (args: { data: Message }) => boolean
-	get: ((args: { where: { id: Message["id"] } }) => Readonly<Message>) & {
-		subscribe: (
-			args: { where: { id: Message["id"] } },
-			callback: (message: Message) => void
-		) => void
-	}
-	// use getByDefaultAlias() to resolve a message from its alias, not subscribable
-	getByDefaultAlias: ((alias: Message["alias"]["default"]) => Readonly<Message>) & {
-		subscribe: (alias: Message["alias"]["default"], callback: (message: Message) => void) => void
-	}
-	includedMessageIds: Subscribable<Message["id"][]>
-	/*
-	 * getAll is deprecated do not use it
-	 */
-	getAll: Subscribable<Readonly<Message[]>>
-	update: (args: { where: { id: Message["id"] }; data: Partial<Message> }) => boolean
-	upsert: (args: { where: { id: Message["id"] }; data: Message }) => void
-	delete: (args: { where: { id: Message["id"] } }) => boolean
-	setDelegate: (delegate: MessageQueryDelegate | undefined, callOnLoad: boolean) => void
-}
-
-export type MessageLintReportsQueryApi = {
-	getAll: Subscribable<MessageLintReport[]> & {
-		settled: () => Promise<MessageLintReport[]>
-	}
-	get: ((args: {
-		where: { messageId: MessageLintReport["messageId"] }
-	}) => Readonly<MessageLintReport[]>) & {
-		subscribe: (
-			args: { where: { messageId: MessageLintReport["messageId"] } },
-			callback: (MessageLintRules: Readonly<MessageLintReport[]>) => void
-		) => void
-	}
-}

package/src/createMessageLintReportsQuery.ts

@@ -1,225 +0,0 @@
-import type {
-	InlangProject,
-	InstalledMessageLintRule,
-	MessageLintReportsQueryApi,
-	MessageQueryApi,
-	MessageQueryDelegate,
-} from "./api.js"
-import type { ProjectSettings } from "@inlang/project-settings"
-import type { resolveModules } from "./resolve-modules/index.js"
-import type { MessageLintReport, Message } from "./versionedInterfaces.js"
-import { lintSingleMessage } from "./lint/index.js"
-
-import { ReactiveMap } from "./reactivity/map.js"
-import { createMemo, onCleanup, untrack, batch } from "./reactivity/solid.js"
-import { createSubscribable } from "./loadProject.js"
-
-import _debug from "debug"
-const debug = _debug("sdk:lintReports")
-
-/**
- * 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,
-	settings: () => ProjectSettings,
-	installedMessageLintRules: () => Array<InstalledMessageLintRule>,
-	resolvedModules: () => Awaited<ReturnType<typeof resolveModules>> | undefined
-): InlangProject["query"]["messageLintReports"] {
-	// @ts-expect-error Reactive map seems to have a problem with Type aliases here
-	const index = new ReactiveMap<MessageLintReport["messageId"], MessageLintReport[]>()
-
-	debug("resetting settledReports")
-	let settledReports = Promise.resolve()
-
-	let currentBatchEnd: undefined | (() => Promise<void>) = undefined
-
-	const updatedReports: { [messageId: string]: MessageLintReport[] } = {}
-
-	// triggered whenever settings or resolved modules changes
-	createMemo(() => {
-		// we clear the index independent from the change for
-		index.clear()
-
-		onCleanup(() => {
-			messagesQuery.setDelegate(undefined, false)
-		})
-
-		// settings is a signal - effect will be called whenever settings changes
-		const _settings = settings()
-		if (!_settings) return
-
-		const _resolvedModules = resolvedModules()
-		if (!_resolvedModules) return
-
-		// resolvedModules is a signal - effect will be called whenever resolvedModules changes
-		const rulesArray = _resolvedModules.messageLintRules
-
-		const messageLintRuleLevels = Object.fromEntries(
-			installedMessageLintRules().map((rule) => [rule.id, rule.level])
-		)
-		const settingsObject = () => {
-			return {
-				...settings(),
-				messageLintRuleLevels,
-			}
-		}
-
-		const sheduleLintMessage = (message: Message, messages: Message[]) => {
-			debug("shedule Lint for message:", message.id)
-
-			const updateOutstandingReportsOnLast = async () => {
-				if (currentBatchEnd !== updateOutstandingReportsOnLast) {
-					debug("skip triggering reactivy", message.id)
-					return
-				}
-				debug("finished queue - trigger reactivity", message.id)
-
-				batch(() => {
-					for (const [id, reports] of Object.entries(updatedReports)) {
-						const currentReports = index.get(id)
-						// we only update the report if it differs from the known one - to not trigger reactivity
-						if (!reportsEqual(currentReports, reports)) {
-							debug("lint reports for message: ", id, " now n:", reports.length)
-							index.set(id, reports)
-						}
-					}
-				})
-			}
-
-			currentBatchEnd = updateOutstandingReportsOnLast
-
-			const scheduledLint = lintSingleMessage({
-				rules: rulesArray,
-				settings: settingsObject(),
-				messages: messages,
-				message: message,
-			}).then((reportsResult) => {
-				if (reportsResult.errors.length === 0) {
-					debug("lint reports for message: ", message.id, "n:", reportsResult.data.length)
-					updatedReports[message.id] = reportsResult.data
-				}
-
-				return updateOutstandingReportsOnLast()
-			})
-			settledReports = settledReports.then(() => scheduledLint)
-		}
-
-		// setup delegate of message query
-		const messageQueryChangeDelegate: MessageQueryDelegate = {
-			onCleanup: () => {
-				// NOTE: we could cancel all running lint rules - but results get overritten anyway
-				index.clear()
-			},
-			onLoaded: (messages: Message[]) => {
-				// for (const message of messages) {
-				// 	lintMessage(message, messages)
-				// }
-				debug("sheduluing Lint for all messages - on load")
-				batch(() => {
-					debug("sheduluing Lint for all messages - subsquencial call?")
-					for (const message of messages) {
-						// NOTE: this potentually creates thousands of promisses we could create a promise that batches linting
-						// NOTE: this produces a lot of signals - we could batch the
-						sheduleLintMessage(message, messages)
-					}
-				})
-			},
-			onMessageCreate: (messageId: string, message: Message, messages: Message[]) => {
-				// NOTE: unhandled promise rejection (as before the refactor) but won't tackle this in this pr
-				// TODO MESDK-105 reevaluate all lint's instead of those for the messsage that where created
-				debug("shedule Lint for message - onMessageCreate", message.id)
-				sheduleLintMessage(message, messages)
-			},
-			onMessageUpdate: (messageId: string, message: Message, messages: Message[]) => {
-				// NOTE: unhandled promise rejection (as before the refactor) but won't tackle this in this pr
-				// TODO MESDK-105 reevaluate all lint's instead of those for the messsage that changed
-				debug("shedule Lint for message - onMessageUpdate", message.id)
-				sheduleLintMessage(message, messages)
-			},
-			// eslint-disable-next-line @typescript-eslint/no-unused-vars -- TODO MESDK-105 we gonna need the mesage Property for evaluation
-			onMessageDelete: (messageId: string, _messages: Message[]) => {
-				index.delete(messageId)
-			},
-		}
-
-		untrack(() => {
-			messagesQuery.setDelegate(messageQueryChangeDelegate, true)
-		})
-	})
-
-	const get = (args: Parameters<MessageLintReportsQueryApi["get"]>[0]) => {
-		debug("get", args.where.messageId)
-		return structuredClone(index.get(args.where.messageId))
-	}
-
-	const getAll = () => {
-		const flatValues = [...index.values()].flat()
-		debug("getAll", flatValues.length)
-		return structuredClone(flatValues.length === 0 ? [] : flatValues) as MessageLintReport[]
-	}
-
-	return {
-		getAll: Object.assign(createSubscribable(getAll), {
-			settled: async () => {
-				await settledReports
-				return getAll()
-			},
-		}),
-		get: Object.assign(get, {
-			subscribe: (
-				args: Parameters<MessageLintReportsQueryApi["get"]["subscribe"]>[0],
-				callback: Parameters<MessageLintReportsQueryApi["get"]["subscribe"]>[1]
-			) => createSubscribable(() => get(args)).subscribe(callback),
-		}) as any,
-	}
-}
-
-function reportsEqual(
-	reportsA: MessageLintReport[] | undefined,
-	reportsB: MessageLintReport[] | undefined
-) {
-	if (reportsA === undefined && reportsB === undefined) {
-		return true
-	} else if (reportsA === undefined || reportsB === undefined) {
-		return false
-	}
-
-	if (reportsA.length !== reportsB.length) {
-		return false
-	}
-
-	for (const [i, element] of reportsA.entries()) {
-		if (element?.languageTag !== reportsB[i]?.languageTag) {
-			return false
-		}
-
-		if (element?.level !== reportsB[i]?.level) {
-			return false
-		}
-
-		if (element?.ruleId !== reportsB[i]?.ruleId) {
-			return false
-		}
-
-		if (typeof element?.body !== typeof reportsB[i]?.body) {
-			return false
-		}
-
-		if (typeof element?.body === "string") {
-			if (reportsB[i]?.body !== reportsB[i]?.body) {
-				return false
-			}
-		} else {
-			// NOTE: this was the fastest way to check if both bodies are equal - we can optimize that later if needed
-			if (JSON.stringify(element?.body) !== JSON.stringify(element?.body)) {
-				return false
-			}
-		}
-	}
-	return true
-}