@inlang/paraglide-js 1.0.0-prerelease.0

package/dist/compiled-output/example-typescript/runtime.js

@@ -0,0 +1,112 @@
+
+/** @type {((tag: AvailableLanguageTag) => void) | undefined} */ 
+let _onSetLanguageTag
+
+/**
+ * The project's source language tag.
+ * 
+ * @example
+ *   if (newlySelectedLanguageTag === sourceLanguageTag){
+ *     // do nothing as the source language tag is the default language
+ *     return
+ *   }
+ */
+export const sourceLanguageTag = "en"
+
+/**
+ * The project's available language tags.
+ * 
+ * @example 
+ *   if (availableLanguageTags.includes(userSelectedLanguageTag) === false){
+ *     throw new Error("Language tag not available")
+ *   }
+ */
+export const availableLanguageTags = /** @type {const} */ (["en","de"])
+
+/**
+ * Get the current language tag.
+ * 
+ * @example
+ *   if (languageTag() === "de"){
+ *     console.log("Germany 🇩🇪")
+ *   } else if (languageTag() === "nl"){
+ *     console.log("Netherlands 🇳🇱")
+ *   }
+ * 
+ * @type {() => AvailableLanguageTag}
+ */
+export let languageTag = () => sourceLanguageTag
+
+/**
+ * Set the language tag.
+ * 
+ * @example 
+ * 
+ *   // changing to language 
+ *   setLanguageTag("en")
+ * 
+ *   // passing a getter function also works. 
+ *   // 
+ *   // a getter function is useful for resolving a language tag 
+ *   // on the server where every request has a different language tag
+ *   setLanguageTag(() => {
+ *     return request.langaugeTag
+ *   }) 
+ *
+ * @param {AvailableLanguageTag | (() => AvailableLanguageTag)} tag
+ */
+export const setLanguageTag = (tag) => {
+	if (typeof tag === "function") {
+		languageTag = tag
+	} else {
+		languageTag = () => tag
+	}
+	// call the callback function if it has been defined
+	if (_onSetLanguageTag !== undefined) {
+		_onSetLanguageTag(languageTag())
+	}
+}
+
+/**
+ * Set the `onSetLanguageTag()` callback function.
+ *
+ * The function can be used to trigger client-side side-effects such as 
+ * making a new request to the server with the updated language tag, 
+ * or re-rendering the UI on the client (SPA apps).  
+ * 
+ * - Don't use this function on the server (!).
+ *   Triggering a side-effect is only useful on the client because a server-side
+ *   environment doesn't need to re-render the UI. 
+ *     
+ * - The `onSetLanguageTag()` callback can only be defined once to avoid unexpected behavior.
+ * 
+ * @example
+ *   // if you use inlang paraglide on the server, make sure 
+ *   // to not call `onSetLanguageTag()` on the server
+ *   if (isServer === false) {
+ *     onSetLanguageTag((tag) => {
+ *       // (for example) make a new request to the 
+ *       // server with the updated language tag
+ *       window.location.href = `/${tag}/${window.location.pathname}`
+ *     })
+ *   }
+ *
+ * @param {(languageTag: AvailableLanguageTag) => void} fn
+ */
+export const onSetLanguageTag = (fn) => {
+	if (_onSetLanguageTag !== undefined) {
+		throw new Error("@inlang/paraglide-js: The `onSetLanguageTag()` callback has already been defined.\n\nThe `onSetLanguageTag()` callback can only be defined once to avoid unexpected behavior.\n\n 1) Try searching for `onSetLanguageTag()` in your codebase for potential duplicated.\n 2) It might be that your framework is calling `onSetLanguageTag()` multiple times. Try to move the `onSetLanguageTag()` out of the rendering scope like a React component.")
+	}
+	_onSetLanguageTag = fn
+}
+
+// ------ TYPES ------
+
+/**
+ * A language tag that is available in the project.
+ * 
+ * @example
+ *   setLanguageTag(request.languageTag as AvailableLanguageTag)
+ * 
+ * @typedef {typeof availableLanguageTags[number]} AvailableLanguageTag
+ */

package/dist/compiled-output/nextjs-example/messages.d.ts

@@ -0,0 +1,7 @@
+export function currentLanguageTag(params: {
+    languageTag: NonNullable<unknown>;
+}): string;
+export function greeting(params: {
+    name: NonNullable<unknown>;
+    count: NonNullable<unknown>;
+}): string;

package/dist/compiled-output/nextjs-example/messages.js

@@ -0,0 +1,42 @@
+
+import { languageTag } from "./runtime.js"
+
+
+/**
+ * This message has been compiled by [inlang paraglide](https://inlang.com/marketplace/library.inlang.paraglideJs).
+ *
+ * - Don't edit the message manually. Use the [inlang ide extension](https://inlang.com/marketplace/app.inlang.ideExtension)
+ *   or the [web editor](https://inlang.com/marketplace/app.inlang.editor) to edit the message.
+ * 
+ * - The params are NonNullable<unknown> because inlang can't know the value type of a param (yet).
+ * 
+ * @param {{ languageTag: NonNullable<unknown> }} params
+ * @returns {string}
+ */
+  export const currentLanguageTag = (params) => {
+    const variants = {
+      "en": `The current language tag is "${params.languageTag}".`,
+  "de": `Der aktuelle Sprachtag ist "${params.languageTag}".`
+	}
+	return variants[languageTag()] ?? "currentLanguageTag"
+}
+
+
+/**
+ * This message has been compiled by [inlang paraglide](https://inlang.com/marketplace/library.inlang.paraglideJs).
+ *
+ * - Don't edit the message manually. Use the [inlang ide extension](https://inlang.com/marketplace/app.inlang.ideExtension)
+ *   or the [web editor](https://inlang.com/marketplace/app.inlang.editor) to edit the message.
+ * 
+ * - The params are NonNullable<unknown> because inlang can't know the value type of a param (yet).
+ * 
+ * @param {{ name: NonNullable<unknown>, count: NonNullable<unknown> }} params
+ * @returns {string}
+ */
+  export const greeting = (params) => {
+    const variants = {
+      "en": `Welcome ${params.name}! You have ${params.count} messages.`,
+  "de": `Hallo ${params.name}! Du hast ${params.count} Nachrichten.`
+	}
+	return variants[languageTag()] ?? "greeting"
+}

package/dist/compiled-output/nextjs-example/runtime.d.ts

@@ -0,0 +1,38 @@
+/**
+ * The project's source language tag.
+ *
+ * @example
+ *   if (newlySelectedLanguageTag === sourceLanguageTag){
+ *     // do nothing as the source language tag is the default language
+ *     return
+ *   }
+ */
+export const sourceLanguageTag: "en";
+/**
+ * The project's available language tags.
+ *
+ * @example
+ *   if (availableLanguageTags.includes(userSelectedLanguageTag) === false){
+ *     throw new Error("Language tag not available")
+ *   }
+ */
+export const availableLanguageTags: readonly ["en", "de"];
+/**
+ * Get the current language tag.
+ *
+ * @example
+ *   if (languageTag() === "de"){
+ *     console.log("Germany 🇩🇪")
+ *   } else if (languageTag() === "nl"){
+ *     console.log("Netherlands 🇳🇱")
+ *   }
+ *
+ * @type {() => AvailableLanguageTag}
+ */
+export let languageTag: () => AvailableLanguageTag;
+export function setLanguageTag(tag: AvailableLanguageTag | (() => AvailableLanguageTag)): void;
+export function onSetLanguageTag(fn: (languageTag: any) => void): void;
+/**
+ * A language tag that is available in the project.
+ */
+export type AvailableLanguageTag = (typeof availableLanguageTags)[number];

package/dist/compiled-output/nextjs-example/runtime.js

@@ -0,0 +1,112 @@
+
+/** @type {((tag: AvailableLanguageTag) => void) | undefined} */ 
+let _onSetLanguageTag
+
+/**
+ * The project's source language tag.
+ * 
+ * @example
+ *   if (newlySelectedLanguageTag === sourceLanguageTag){
+ *     // do nothing as the source language tag is the default language
+ *     return
+ *   }
+ */
+export const sourceLanguageTag = "en"
+
+/**
+ * The project's available language tags.
+ * 
+ * @example 
+ *   if (availableLanguageTags.includes(userSelectedLanguageTag) === false){
+ *     throw new Error("Language tag not available")
+ *   }
+ */
+export const availableLanguageTags = /** @type {const} */ (["en","de"])
+
+/**
+ * Get the current language tag.
+ * 
+ * @example
+ *   if (languageTag() === "de"){
+ *     console.log("Germany 🇩🇪")
+ *   } else if (languageTag() === "nl"){
+ *     console.log("Netherlands 🇳🇱")
+ *   }
+ * 
+ * @type {() => AvailableLanguageTag}
+ */
+export let languageTag = () => sourceLanguageTag
+
+/**
+ * Set the language tag.
+ * 
+ * @example 
+ * 
+ *   // changing to language 
+ *   setLanguageTag("en")
+ * 
+ *   // passing a getter function also works. 
+ *   // 
+ *   // a getter function is useful for resolving a language tag 
+ *   // on the server where every request has a different language tag
+ *   setLanguageTag(() => {
+ *     return request.langaugeTag
+ *   }) 
+ *
+ * @param {AvailableLanguageTag | (() => AvailableLanguageTag)} tag
+ */
+export const setLanguageTag = (tag) => {
+	if (typeof tag === "function") {
+		languageTag = tag
+	} else {
+		languageTag = () => tag
+	}
+	// call the callback function if it has been defined
+	if (_onSetLanguageTag !== undefined) {
+		_onSetLanguageTag(languageTag())
+	}
+}
+
+/**
+ * Set the `onSetLanguageTag()` callback function.
+ *
+ * The function can be used to trigger client-side side-effects such as 
+ * making a new request to the server with the updated language tag, 
+ * or re-rendering the UI on the client (SPA apps).  
+ * 
+ * - Don't use this function on the server (!).
+ *   Triggering a side-effect is only useful on the client because a server-side
+ *   environment doesn't need to re-render the UI. 
+ *     
+ * - The `onSetLanguageTag()` callback can only be defined once to avoid unexpected behavior.
+ * 
+ * @example
+ *   // if you use inlang paraglide on the server, make sure 
+ *   // to not call `onSetLanguageTag()` on the server
+ *   if (isServer === false) {
+ *     onSetLanguageTag((tag) => {
+ *       // (for example) make a new request to the 
+ *       // server with the updated language tag
+ *       window.location.href = `/${tag}/${window.location.pathname}`
+ *     })
+ *   }
+ *
+ * @param {(languageTag: AvailableLanguageTag) => void} fn
+ */
+export const onSetLanguageTag = (fn) => {
+	if (_onSetLanguageTag !== undefined) {
+		throw new Error("@inlang/paraglide-js: The `onSetLanguageTag()` callback has already been defined.\n\nThe `onSetLanguageTag()` callback can only be defined once to avoid unexpected behavior.\n\n 1) Try searching for `onSetLanguageTag()` in your codebase for potential duplicated.\n 2) It might be that your framework is calling `onSetLanguageTag()` multiple times. Try to move the `onSetLanguageTag()` out of the rendering scope like a React component.")
+	}
+	_onSetLanguageTag = fn
+}
+
+// ------ TYPES ------
+
+/**
+ * A language tag that is available in the project.
+ * 
+ * @example
+ *   setLanguageTag(request.languageTag as AvailableLanguageTag)
+ * 
+ * @typedef {typeof availableLanguageTags[number]} AvailableLanguageTag
+ */

package/dist/compiled-output/react-example/messages.d.ts

@@ -0,0 +1,7 @@
+export function currentLanguageTag(params: {
+    languageTag: NonNullable<unknown>;
+}): string;
+export function greeting(params: {
+    name: NonNullable<unknown>;
+    count: NonNullable<unknown>;
+}): string;

package/dist/compiled-output/react-example/messages.js

@@ -0,0 +1,42 @@
+
+import { languageTag } from "./runtime.js"
+
+
+/**
+ * This message has been compiled by [inlang paraglide](https://inlang.com/marketplace/library.inlang.paraglideJs).
+ *
+ * - Don't edit the message manually. Use the [inlang ide extension](https://inlang.com/marketplace/app.inlang.ideExtension)
+ *   or the [web editor](https://inlang.com/marketplace/app.inlang.editor) to edit the message.
+ * 
+ * - The params are NonNullable<unknown> because inlang can't know the value type of a param (yet).
+ * 
+ * @param {{ languageTag: NonNullable<unknown> }} params
+ * @returns {string}
+ */
+  export const currentLanguageTag = (params) => {
+    const variants = {
+      "en": `The current language tag is "${params.languageTag}".`,
+  "de": `Der aktuelle Sprachtag ist "${params.languageTag}".`
+	}
+	return variants[languageTag()] ?? "currentLanguageTag"
+}
+
+
+/**
+ * This message has been compiled by [inlang paraglide](https://inlang.com/marketplace/library.inlang.paraglideJs).
+ *
+ * - Don't edit the message manually. Use the [inlang ide extension](https://inlang.com/marketplace/app.inlang.ideExtension)
+ *   or the [web editor](https://inlang.com/marketplace/app.inlang.editor) to edit the message.
+ * 
+ * - The params are NonNullable<unknown> because inlang can't know the value type of a param (yet).
+ * 
+ * @param {{ name: NonNullable<unknown>, count: NonNullable<unknown> }} params
+ * @returns {string}
+ */
+  export const greeting = (params) => {
+    const variants = {
+      "en": `Welcome ${params.name}! You have ${params.count} messages.`,
+  "de": `Hallo ${params.name}! Du hast ${params.count} Nachrichten.`
+	}
+	return variants[languageTag()] ?? "greeting"
+}

package/dist/compiled-output/react-example/runtime.d.ts

@@ -0,0 +1,38 @@
+/**
+ * The project's source language tag.
+ *
+ * @example
+ *   if (newlySelectedLanguageTag === sourceLanguageTag){
+ *     // do nothing as the source language tag is the default language
+ *     return
+ *   }
+ */
+export const sourceLanguageTag: "en";
+/**
+ * The project's available language tags.
+ *
+ * @example
+ *   if (availableLanguageTags.includes(userSelectedLanguageTag) === false){
+ *     throw new Error("Language tag not available")
+ *   }
+ */
+export const availableLanguageTags: readonly ["en", "de"];
+/**
+ * Get the current language tag.
+ *
+ * @example
+ *   if (languageTag() === "de"){
+ *     console.log("Germany 🇩🇪")
+ *   } else if (languageTag() === "nl"){
+ *     console.log("Netherlands 🇳🇱")
+ *   }
+ *
+ * @type {() => AvailableLanguageTag}
+ */
+export let languageTag: () => AvailableLanguageTag;
+export function setLanguageTag(tag: AvailableLanguageTag | (() => AvailableLanguageTag)): void;
+export function onSetLanguageTag(fn: (languageTag: any) => void): void;
+/**
+ * A language tag that is available in the project.
+ */
+export type AvailableLanguageTag = (typeof availableLanguageTags)[number];

package/dist/compiled-output/react-example/runtime.js

@@ -0,0 +1,112 @@
+
+/** @type {((tag: AvailableLanguageTag) => void) | undefined} */ 
+let _onSetLanguageTag
+
+/**
+ * The project's source language tag.
+ * 
+ * @example
+ *   if (newlySelectedLanguageTag === sourceLanguageTag){
+ *     // do nothing as the source language tag is the default language
+ *     return
+ *   }
+ */
+export const sourceLanguageTag = "en"
+
+/**
+ * The project's available language tags.
+ * 
+ * @example 
+ *   if (availableLanguageTags.includes(userSelectedLanguageTag) === false){
+ *     throw new Error("Language tag not available")
+ *   }
+ */
+export const availableLanguageTags = /** @type {const} */ (["en","de"])
+
+/**
+ * Get the current language tag.
+ * 
+ * @example
+ *   if (languageTag() === "de"){
+ *     console.log("Germany 🇩🇪")
+ *   } else if (languageTag() === "nl"){
+ *     console.log("Netherlands 🇳🇱")
+ *   }
+ * 
+ * @type {() => AvailableLanguageTag}
+ */
+export let languageTag = () => sourceLanguageTag
+
+/**
+ * Set the language tag.
+ * 
+ * @example 
+ * 
+ *   // changing to language 
+ *   setLanguageTag("en")
+ * 
+ *   // passing a getter function also works. 
+ *   // 
+ *   // a getter function is useful for resolving a language tag 
+ *   // on the server where every request has a different language tag
+ *   setLanguageTag(() => {
+ *     return request.langaugeTag
+ *   }) 
+ *
+ * @param {AvailableLanguageTag | (() => AvailableLanguageTag)} tag
+ */
+export const setLanguageTag = (tag) => {
+	if (typeof tag === "function") {
+		languageTag = tag
+	} else {
+		languageTag = () => tag
+	}
+	// call the callback function if it has been defined
+	if (_onSetLanguageTag !== undefined) {
+		_onSetLanguageTag(languageTag())
+	}
+}
+
+/**
+ * Set the `onSetLanguageTag()` callback function.
+ *
+ * The function can be used to trigger client-side side-effects such as 
+ * making a new request to the server with the updated language tag, 
+ * or re-rendering the UI on the client (SPA apps).  
+ * 
+ * - Don't use this function on the server (!).
+ *   Triggering a side-effect is only useful on the client because a server-side
+ *   environment doesn't need to re-render the UI. 
+ *     
+ * - The `onSetLanguageTag()` callback can only be defined once to avoid unexpected behavior.
+ * 
+ * @example
+ *   // if you use inlang paraglide on the server, make sure 
+ *   // to not call `onSetLanguageTag()` on the server
+ *   if (isServer === false) {
+ *     onSetLanguageTag((tag) => {
+ *       // (for example) make a new request to the 
+ *       // server with the updated language tag
+ *       window.location.href = `/${tag}/${window.location.pathname}`
+ *     })
+ *   }
+ *
+ * @param {(languageTag: AvailableLanguageTag) => void} fn
+ */
+export const onSetLanguageTag = (fn) => {
+	if (_onSetLanguageTag !== undefined) {
+		throw new Error("@inlang/paraglide-js: The `onSetLanguageTag()` callback has already been defined.\n\nThe `onSetLanguageTag()` callback can only be defined once to avoid unexpected behavior.\n\n 1) Try searching for `onSetLanguageTag()` in your codebase for potential duplicated.\n 2) It might be that your framework is calling `onSetLanguageTag()` multiple times. Try to move the `onSetLanguageTag()` out of the rendering scope like a React component.")
+	}
+	_onSetLanguageTag = fn
+}
+
+// ------ TYPES ------
+
+/**
+ * A language tag that is available in the project.
+ * 
+ * @example
+ *   setLanguageTag(request.languageTag as AvailableLanguageTag)
+ * 
+ * @typedef {typeof availableLanguageTags[number]} AvailableLanguageTag
+ */

package/dist/compiled-output/svelte-example/messages.d.ts

@@ -0,0 +1,7 @@
+export function currentLanguageTag(params: {
+    languageTag: NonNullable<unknown>;
+}): string;
+export function greeting(params: {
+    name: NonNullable<unknown>;
+    count: NonNullable<unknown>;
+}): string;

package/dist/compiled-output/svelte-example/messages.js

@@ -0,0 +1,42 @@
+
+import { languageTag } from "./runtime.js"
+
+
+/**
+ * This message has been compiled by [inlang paraglide](https://inlang.com/marketplace/library.inlang.paraglideJs).
+ *
+ * - Don't edit the message manually. Use the [inlang ide extension](https://inlang.com/marketplace/app.inlang.ideExtension)
+ *   or the [web editor](https://inlang.com/marketplace/app.inlang.editor) to edit the message.
+ * 
+ * - The params are NonNullable<unknown> because inlang can't know the value type of a param (yet).
+ * 
+ * @param {{ languageTag: NonNullable<unknown> }} params
+ * @returns {string}
+ */
+  export const currentLanguageTag = (params) => {
+    const variants = {
+      "en": `The current language tag is "${params.languageTag}".`,
+  "de": `Der aktuelle Sprachtag ist "${params.languageTag}".`
+	}
+	return variants[languageTag()] ?? "currentLanguageTag"
+}
+
+
+/**
+ * This message has been compiled by [inlang paraglide](https://inlang.com/marketplace/library.inlang.paraglideJs).
+ *
+ * - Don't edit the message manually. Use the [inlang ide extension](https://inlang.com/marketplace/app.inlang.ideExtension)
+ *   or the [web editor](https://inlang.com/marketplace/app.inlang.editor) to edit the message.
+ * 
+ * - The params are NonNullable<unknown> because inlang can't know the value type of a param (yet).
+ * 
+ * @param {{ name: NonNullable<unknown>, count: NonNullable<unknown> }} params
+ * @returns {string}
+ */
+  export const greeting = (params) => {
+    const variants = {
+      "en": `Welcome ${params.name}! You have ${params.count} messages.`,
+  "de": `Hallo ${params.name}! Du hast ${params.count} Nachrichten.`
+	}
+	return variants[languageTag()] ?? "greeting"
+}

package/dist/compiled-output/svelte-example/runtime.d.ts

@@ -0,0 +1,38 @@
+/**
+ * The project's source language tag.
+ *
+ * @example
+ *   if (newlySelectedLanguageTag === sourceLanguageTag){
+ *     // do nothing as the source language tag is the default language
+ *     return
+ *   }
+ */
+export const sourceLanguageTag: "en";
+/**
+ * The project's available language tags.
+ *
+ * @example
+ *   if (availableLanguageTags.includes(userSelectedLanguageTag) === false){
+ *     throw new Error("Language tag not available")
+ *   }
+ */
+export const availableLanguageTags: readonly ["en", "de"];
+/**
+ * Get the current language tag.
+ *
+ * @example
+ *   if (languageTag() === "de"){
+ *     console.log("Germany 🇩🇪")
+ *   } else if (languageTag() === "nl"){
+ *     console.log("Netherlands 🇳🇱")
+ *   }
+ *
+ * @type {() => AvailableLanguageTag}
+ */
+export let languageTag: () => AvailableLanguageTag;
+export function setLanguageTag(tag: AvailableLanguageTag | (() => AvailableLanguageTag)): void;
+export function onSetLanguageTag(fn: (languageTag: any) => void): void;
+/**
+ * A language tag that is available in the project.
+ */
+export type AvailableLanguageTag = (typeof availableLanguageTags)[number];