@inlang/sdk 0.36.3 → 2.0.0-beta.1

package/src/storage/human-id/human-readable-id.ts

@@ -1,27 +0,0 @@
-// we use murmur for best distribution https://medium.com/miro-engineering/choosing-a-hash-function-to-solve-a-data-sharding-problem-c656259e2b54
-import murmurhash3 from "murmurhash3js"
-import { adjectives, animals, adverbs, verbs } from "./words.js"
-
-export function randomHumanId() {
-	return `${adjectives[Math.floor(Math.random() * 256)]}_${
-		adjectives[Math.floor(Math.random() * 256)]
-	}_${animals[Math.floor(Math.random() * 256)]}_${verbs[Math.floor(Math.random() * 256)]}`
-}
-
-export function humanIdHash(value: string, offset: number = 0) {
-	// Seed value can be any arbitrary value
-	const seed = 42
-
-	// Use MurmurHash3 to produce a 32-bit hash
-	const hash32 = murmurhash3.x86.hash32(value, seed)
-	// Add 1 and take modulo 2^32 to fit within 32 bits
-	const hash32WithOffset: number = (hash32 + offset) >>> 0
-
-	// Extract four 8-bit parts
-	const part1 = (hash32WithOffset >>> 24) & 0xff
-	const part2 = (hash32WithOffset >>> 16) & 0xff
-	const part3 = (hash32WithOffset >>> 8) & 0xff
-	const part4 = hash32WithOffset & 0xff
-
-	return `${adjectives[part1]}_${animals[part2]}_${verbs[part3]}_${adverbs[part4]}`
-}

package/src/telemetry/capture.ts

@@ -1,49 +0,0 @@
-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/src/telemetry/groupIdentify.ts

@@ -1,41 +0,0 @@
-import { ENV_VARIABLES } from "../env-variables/index.js"
-
-/**
- * Capture an event.
- *
- * - manually calling the PostHog API because the SDKs were not platform angostic (and generally bloated)
- */
-export const identifyProject = async (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: "$groupidentify",
-				// id is "unknown" because no user information is available
-				distinct_id: "unknown",
-				properties: {
-					$group_type: "project",
-					$group_key: args.projectId,
-					$group_set: {
-						...args.properties,
-					},
-				},
-			}),
-		})
-	} catch (e) {
-		// TODO implement sentry logging
-		// do not console.log and avoid exposing internal errors to the user
-	}
-}

package/src/test-utilities/createMessage.test.ts

@@ -1,118 +0,0 @@
-import { expect, test } from "vitest"
-import { createMessage } from "./createMessage.js"
-
-test("should create a simple message", () => {
-	expect(
-		createMessage("welcome", {
-			de: "Hallo inlang",
-		})
-	).toMatchInlineSnapshot(
-		{
-			alias: {},
-			id: "welcome",
-			selectors: [],
-			variants: [
-				{
-					languageTag: "de",
-					match: [],
-					pattern: [
-						{
-							type: "Text",
-							value: "Hallo inlang",
-						},
-					],
-				},
-			],
-		},
-		`
-		{
-		  "alias": {},
-		  "id": "welcome",
-		  "selectors": [],
-		  "variants": [
-		    {
-		      "languageTag": "de",
-		      "match": [],
-		      "pattern": [
-		        {
-		          "type": "Text",
-		          "value": "Hallo inlang",
-		        },
-		      ],
-		    },
-		  ],
-		}
-	`
-	)
-})
-
-test("should create a message with pattern", () => {
-	expect(
-		createMessage("greeting", {
-			en: [
-				{ type: "Text", value: "Hi " },
-				{ type: "VariableReference", name: "name" },
-				{ type: "Text", value: '"' },
-			],
-		})
-	).toStrictEqual({
-		alias: {},
-		id: "greeting",
-		selectors: [],
-		variants: [
-			{
-				languageTag: "en",
-				match: [],
-				pattern: [
-					{
-						type: "Text",
-						value: "Hi ",
-					},
-					{
-						name: "name",
-						type: "VariableReference",
-					},
-					{
-						type: "Text",
-						value: '"',
-					},
-				],
-			},
-		],
-	})
-})
-
-test("should create a message with a pattern", () => {
-	expect(
-		createMessage("welcome", {
-			en: "hello inlang",
-			de: [{ type: "Text", value: "Hallo inlang" }],
-		})
-	).toStrictEqual({
-		alias: {},
-		id: "welcome",
-		selectors: [],
-		variants: [
-			{
-				languageTag: "en",
-				match: [],
-				pattern: [
-					{
-						type: "Text",
-						value: "hello inlang",
-					},
-				],
-			},
-			{
-				languageTag: "de",
-				match: [],
-				pattern: [
-					{
-						type: "Text",
-						value: "Hallo inlang",
-					},
-				],
-			},
-		],
-	})
-})

package/src/test-utilities/createMessage.ts

@@ -1,21 +0,0 @@
-import type { Message, Pattern } from "@inlang/message"
-
-export const createMessage = (id: string, patterns: Record<string, Pattern | string>) =>
-	({
-		id,
-		alias: {},
-		selectors: [],
-		variants: Object.entries(patterns).map(([languageTag, patterns]) => ({
-			languageTag,
-			match: [],
-			pattern:
-				typeof patterns === "string"
-					? [
-							{
-								type: "Text",
-								value: patterns,
-							},
-					  ]
-					: patterns,
-		})),
-	} satisfies Message)

package/src/test-utilities/index.ts

@@ -1,2 +0,0 @@
-export { createMessage } from "./createMessage.js"
-export { createNodeishMemoryFs } from "@lix-js/fs"

package/src/test-utilities/sleep.ts

@@ -1,11 +0,0 @@
-export function sleep(ms: number) {
-	return new Promise((resolve) => setTimeout(resolve, ms))
-}
-
-export function delay(v: unknown, ms: number) {
-	return new Promise((resolve) => setTimeout(() => resolve(v), ms))
-}
-
-export function fail(ms: number) {
-	return new Promise((resolve, reject) => setTimeout(() => reject(new Error("fail")), ms))
-}

package/src/v2/helper.test.ts

@@ -1,95 +0,0 @@
-import { describe, it, expect } from "vitest"
-import { createMessageBundle, createMessage } from "./helper.js"
-import { MessageBundle } from "./types.js"
-import { Value } from "@sinclair/typebox/value"
-
-describe("createMessageBundle", () => {
-	it("creates a bundle with no messages", () => {
-		const bundle: unknown = createMessageBundle({ id: "no_messages", messages: [] })
-		expect(Value.Check(MessageBundle, bundle)).toBe(true)
-		expect(bundle).toEqual({
-			id: "no_messages",
-			alias: {},
-			messages: [],
-		} satisfies MessageBundle)
-	})
-
-	it("creates a bundle with a single text-only message", () => {
-		const bundle: unknown = createMessageBundle({
-			id: "hello_world",
-			messages: [createMessage({ locale: "en", text: "Hello World!" })],
-		})
-		expect(Value.Check(MessageBundle, bundle)).toBe(true)
-		expect(bundle).toEqual({
-			id: "hello_world",
-			alias: {},
-			messages: [
-				{
-					locale: "en",
-					declarations: [],
-					selectors: [],
-					variants: [
-						{
-							match: [],
-							pattern: [
-								{
-									type: "text",
-									value: "Hello World!",
-								},
-							],
-						},
-					],
-				},
-			],
-		} satisfies MessageBundle)
-	})
-
-	it("creates a bundle with multiple text-only messages", () => {
-		const bundle: unknown = createMessageBundle({
-			id: "hello_world_2",
-			messages: [
-				createMessage({ locale: "en", text: "Hello World!" }),
-				createMessage({ locale: "de", text: "Hallo Welt!" }),
-			],
-		})
-		expect(Value.Check(MessageBundle, bundle)).toBe(true)
-		expect(bundle).toEqual({
-			id: "hello_world_2",
-			alias: {},
-			messages: [
-				{
-					locale: "en",
-					declarations: [],
-					selectors: [],
-					variants: [
-						{
-							match: [],
-							pattern: [
-								{
-									type: "text",
-									value: "Hello World!",
-								},
-							],
-						},
-					],
-				},
-				{
-					locale: "de",
-					declarations: [],
-					selectors: [],
-					variants: [
-						{
-							match: [],
-							pattern: [
-								{
-									type: "text",
-									value: "Hallo Welt!",
-								},
-							],
-						},
-					],
-				},
-			],
-		} satisfies MessageBundle)
-	})
-})

package/src/v2/helper.ts

@@ -1,98 +0,0 @@
-import {
-	LanguageTag,
-	MessageBundle,
-	MessageBundleWithSlots,
-	Message,
-	MessageSlot,
-	Text,
-} from "./types.js"
-
-/**
- * create v2 MessageBundle
- * @example createMessageBundle({
- * 	 id: "greeting",
- *   messages: [
- * 		 createMessage({locale: "en", text: "Hello world!"})
- * 		 createMessage({locale: "de", text: "Hallo Welt!"})
- *   ]
- * })
- */
-export function createMessageBundle(args: {
-	id: string
-	messages: Message[]
-	alias?: MessageBundle["alias"]
-}): MessageBundle {
-	return {
-		id: args.id,
-		alias: args.alias ?? {},
-		messages: args.messages,
-	}
-}
-
-/**
- * create v2 Messsage AST with text-only pattern
- * @example createMessage({locale: "en", text: "Hello world"})
- */
-export function createMessage(args: {
-	locale: LanguageTag
-	text: string
-	match?: Array<string>
-}): Message {
-	return {
-		locale: args.locale,
-		declarations: [],
-		selectors: [],
-		variants: [{ match: args.match ? args.match : [], pattern: [toTextElement(args.text ?? "")] }],
-	}
-}
-
-export function toTextElement(text: string): Text {
-	return {
-		type: "text",
-		value: text,
-	}
-}
-
-// ****************************
-// WIP experimental persistence
-// ****************************
-
-/**
- * create MessageSlot for a locale (only used for persistence)
- */
-export function createMessageSlot(locale: LanguageTag): MessageSlot {
-	return {
-		locale,
-		slot: true,
-	}
-}
-
-/**
- * return structuredClone with message slots for all locales not yet present
- */
-export function addSlots(messageBundle: MessageBundle, locales: string[]): MessageBundleWithSlots {
-	const bundle = structuredClone(messageBundle) as MessageBundleWithSlots
-	bundle.messages = locales.map((locale) => {
-		return bundle.messages.find((message) => message.locale === locale) ?? createMessageSlot(locale)
-	})
-	return bundle
-}
-
-/**
- * remove empty message slots without first creating a structured clone
- */
-export function removeSlots(messageBundle: MessageBundleWithSlots) {
-	messageBundle.messages = messageBundle.messages.filter((message) => !("slot" in message))
-	return messageBundle as MessageBundle
-}
-
-/**
- * Add newlines between bundles and messages to avoid merge conflicts
- */
-export function injectJSONNewlines(json: string): string {
-	return json
-		.replace(/\{"id":"/g, '\n\n\n\n{"id":"')
-		.replace(/"messages":\[\{"locale":"/g, '"messages":[\n\n\n\n{"locale":"')
-		.replace(/\}\]\}\]\},\{"locale":"/g, '}]}]},\n\n\n\n{"locale":"')
-		.replace(/"slot":true\},\{"locale":/g, '"slot":true},\n\n\n\n{"locale":')
-}

package/src/v2/index.ts

@@ -1,3 +0,0 @@
-export type * from "./types.js"
-export * from "./helper.js"
-export * from "./shim.js"

package/src/v2/mocks/index.ts

@@ -1,2 +0,0 @@
-export * from "./plural/bundle.js"
-export * from "./multipleMatcher/bundle.js"

package/src/v2/mocks/multipleMatcher/bundle.test.ts

@@ -1,11 +0,0 @@
-import { describe, it, expect } from "vitest"
-import { multipleMatcherBundle } from "./bundle.js"
-import { MessageBundle } from "../../types.js"
-import { Value } from "@sinclair/typebox/value"
-
-describe("mock plural messageBundle", () => {
-	it("is valid", () => {
-		const messageBundle: unknown = multipleMatcherBundle
-		expect(Value.Check(MessageBundle, messageBundle)).toBe(true)
-	})
-})

package/src/v2/mocks/multipleMatcher/bundle.ts

@@ -1,196 +0,0 @@
-import type { MessageBundle } from "../../types.js"
-
-export const multipleMatcherBundle: MessageBundle = {
-	id: "mock-bundle-human-id",
-	alias: {
-		default: "mock-bundle-alias",
-	},
-	messages: [
-		{
-			locale: "en",
-			declarations: [],
-			selectors: [
-				{
-					type: "expression",
-					arg: {
-						type: "variable",
-						name: "count",
-					},
-					annotation: { type: "function", name: "plural", options: [] },
-				},
-			],
-			variants: [
-				{
-					match: ["one"],
-					pattern: [
-						{
-							type: "text",
-							value: "Show ",
-						},
-						{
-							type: "expression",
-							arg: {
-								type: "variable",
-								name: "count",
-							},
-						},
-						{
-							type: "text",
-							value: " message.",
-						},
-					],
-				},
-				{
-					match: ["many"],
-					pattern: [
-						{
-							type: "text",
-							value: "Show ",
-						},
-						{
-							type: "expression",
-							arg: {
-								type: "variable",
-								name: "count",
-							},
-						},
-						{
-							type: "text",
-							value: " messages.",
-						},
-					],
-				},
-				{
-					match: ["*"],
-					pattern: [
-						{
-							type: "text",
-							value: "Show ",
-						},
-						{
-							type: "expression",
-							arg: {
-								type: "variable",
-								name: "count",
-							},
-						},
-					],
-				},
-			],
-		},
-		{
-			locale: "de",
-			declarations: [],
-			selectors: [
-				{
-					type: "expression",
-					arg: {
-						type: "variable",
-						name: "count",
-					},
-					annotation: { type: "function", name: "plural", options: [] },
-				},
-				{
-					type: "expression",
-					arg: {
-						type: "variable",
-						name: "formal",
-					},
-					annotation: { type: "function", name: "bool", options: [] },
-				},
-			],
-			variants: [
-				{
-					match: ["one", "formal"],
-					pattern: [
-						{
-							type: "text",
-							value: "Zeigen Sie bitte Ihre Nachricht.",
-						},
-					],
-				},
-				{
-					match: ["one", "informal"],
-					pattern: [
-						{
-							type: "text",
-							value: "Zeigen Deine Nachricht.",
-						},
-					],
-				},
-				{
-					match: ["many", "formal"],
-					pattern: [
-						{
-							type: "text",
-							value: "Zeigen Sie bitte Ihre ",
-						},
-						{
-							type: "expression",
-							arg: {
-								type: "variable",
-								name: "count",
-							},
-						},
-						{
-							type: "text",
-							value: " Nachrichten.",
-						},
-					],
-				},
-				{
-					match: ["many", "informal"],
-					pattern: [
-						{
-							type: "text",
-							value: "Zeigen Deine ",
-						},
-						{
-							type: "expression",
-							arg: {
-								type: "variable",
-								name: "count",
-							},
-						},
-						{
-							type: "text",
-							value: " Nachrichten.",
-						},
-					],
-				},
-				{
-					match: ["many", "*"],
-					pattern: [
-						{
-							type: "expression",
-							arg: {
-								type: "variable",
-								name: "count",
-							},
-						},
-						{
-							type: "text",
-							value: " Nachrichten zeigen.",
-						},
-					],
-				},
-				{
-					match: ["*"],
-					pattern: [
-						{
-							type: "text",
-							value: "Zeige ",
-						},
-						{
-							type: "expression",
-							arg: {
-								type: "variable",
-								name: "count",
-							},
-						},
-					],
-				},
-			],
-		},
-	],
-}

package/src/v2/mocks/plural/bundle.test.ts

@@ -1,18 +0,0 @@
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
-
-import { describe, it, expect } from "vitest"
-import { pluralBundle } from "./bundle.js"
-import { MessageBundle } from "../../types.js"
-import { Value } from "@sinclair/typebox/value"
-
-describe("mock plural messageBundle", () => {
-	it("is valid", () => {
-		const messageBundle: unknown = pluralBundle
-		expect(Value.Check(MessageBundle, messageBundle)).toBe(true)
-
-		expect(pluralBundle.messages.length).toBe(2)
-		expect(pluralBundle.messages[0]!.declarations.length).toBe(3)
-		expect(pluralBundle.messages[0]!.selectors.length).toBe(1)
-		expect(pluralBundle.messages[0]!.variants.length).toBe(3)
-	})
-})