studiocms 0.1.0-beta.24 → 0.1.0-beta.26

package/dist/virtuals/i18n/config.d.ts

@@ -0,0 +1,430 @@
+/**
+ * This module handles the internationalization (i18n) config for the StudioCMS application for both the Client and Server sides.
+ */
+/**
+ * Dynamically imports the base English translations for server-side internationalization.
+ *
+ * @remarks
+ * This constant loads the default English translation JSON file asynchronously at runtime.
+ * It is intended to be used as the base set of translations for the server.
+ *
+ * - These translations are also converted to a client-friendly format.
+ */
+export declare const baseServerTranslations: {
+    displayName: string;
+    translations: {
+        "@studiocms/auth:login": {
+            title: string;
+            description: string;
+            header: string;
+            "sub-header-usernamepasswordoauth": string;
+            "sub-header-usernamepassword": string;
+            "sub-header-oauth": string;
+            "sub-header-noprovider": string;
+            "username-label": string;
+            "password-label": string;
+            "login-button": string;
+            "allow-registration-noaccount": string;
+            "allow-registration-register": string;
+            "forgot-password": string;
+            "forgot-password-title": string;
+            "forgot-password-message": string;
+            "email-label": string;
+            "demo-mode-credentials": string;
+        };
+        "@studiocms/auth:signup": {
+            title: string;
+            description: string;
+            header: string;
+            "sub-header-usernamepasswordoauth": string;
+            "sub-header-usernamepassword": string;
+            "sub-header-oauth": string;
+            "sub-header-noprovider": string;
+            "username-label": string;
+            "email-label": string;
+            "displayname-label": string;
+            "password-label": string;
+            "confirm-password-label": string;
+            "create-account-button": string;
+            "allow-login-haveaccount": string;
+            "allow-login-login": string;
+        };
+        "@studiocms/auth:logout": {
+            title: string;
+            description: string;
+        };
+        "@studiocms/auth:oauth-stack": {
+            "or-login-with": string;
+        };
+        "@studiocms/dashboard:index": {
+            title: string;
+            description: string;
+            "welcome-title": string;
+            "title-button:discord": string;
+            "title-button:feedback": string;
+            "sub-header": string;
+        };
+        "@studiocms/dashboard:sidebar": {
+            "category-1-header": string;
+            "dashboard-link-label": string;
+            "content-management-label": string;
+            "category-2-header": string;
+            "site-configuration-label": string;
+            "user-management-label": string;
+            "category-3-header": string;
+            "category-3-empty-placeholder": string;
+            "user-dropdown:settings": string;
+            "user-dropdown:view-site": string;
+            "user-dropdown:logout": string;
+            "mailer-configuration-label": string;
+        };
+        "@studiocms/dashboard:profile": {
+            title: string;
+            description: string;
+            header: string;
+            "basic-info-header": string;
+            "basic-info-save-button": string;
+            "basic-info-display-name": string;
+            "basic-info-email": string;
+            "basic-info-username": string;
+            "basic-info-website": string;
+            "user-password-header": string;
+            "user-password-save-button": string;
+            "user-password-no-password": string;
+            "user-password-current": string;
+            "user-password-new": string;
+            "user-password-confirm": string;
+            "social-accounts-header": string;
+            "social-accounts-connected": string;
+            "social-accounts-no-connected": string;
+            "social-accounts-other": string;
+            "social-accounts-no-other": string;
+            "api-tokens-header": string;
+            "api-tokens-create": string;
+            "api-tokens-description": string;
+            "api-tokens-delete-button": string;
+            "api-tokens-created": string;
+            "api-tokens-no-tokens": string;
+            "api-tokens-modal-header": string;
+            "api-tokens-modal-description": string;
+            "api-tokens-modal-response-header": string;
+            "api-tokens-modal-response-description": string;
+            "sync-with-libravatar": string;
+            "basic-avatar-url": string;
+        };
+        "@studiocms/dashboard:password-reset": {
+            title: string;
+            description: string;
+            header: string;
+            "sub-header-start": string;
+            "sub-header-end": string;
+            "password-label": string;
+            "confirm-password-label": string;
+            "reset-button": string;
+        };
+        "@studiocms/dashboard:configuration": {
+            title: string;
+            description: string;
+            header: string;
+            "save-button": string;
+            "dashboard-grid-label": string;
+            "login-page-preview": string;
+            "input-site-title": string;
+            "input-site-description": string;
+            "input-og-image": string;
+            "input-site-icon": string;
+            "input-diff-tracking-limit": string;
+            "input-custom-login-page": string;
+            "select-page-diff-tracking": string;
+            "select-login-page-bg": string;
+            "select-smtp-mailer": string;
+            "select-hide-default-index": string;
+        };
+        "@studiocms/dashboard:smtp": {
+            title: string;
+            description: string;
+            header: string;
+            "save-button": string;
+            "smtp-settings": string;
+            "test-smtp": string;
+            "smtp-host": string;
+            "smtp-host-placeholder": string;
+            "smtp-port": string;
+            "smtp-port-placeholder": string;
+            "smtp-secure": string;
+            "smtp-proxy": string;
+            "smtp-proxy-placeholder": string;
+            "smtp-tls-reject-unauthorized": string;
+            "smtp-tls-servername": string;
+            "smtp-tls-servername-placeholder": string;
+            "smtp-user": string;
+            "smtp-user-placeholder": string;
+            "smtp-password": string;
+            "smtp-password-placeholder": string;
+            "smtp-default-sender": string;
+            "smtp-default-sender-placeholder": string;
+            "test-email": string;
+            "test-email-placeholder": string;
+            "send-test-email": string;
+            "site-email-settings": string;
+            emailVerification: string;
+            requireAdminVerification: string;
+            requireEditorVerification: string;
+            oAuthBypassVerification: string;
+            "save-email-settings": string;
+        };
+        "@studiocms/dashboard:user-mngmt-sidebar": {
+            "input-placeholder-search": string;
+            "dropdown-create-user": string;
+            "dropdown-create-invite": string;
+        };
+        "@studiocms/dashboard:user-mngmt-index": {
+            title: string;
+            description: string;
+            header: string;
+            placeholder: string;
+        };
+        "@studiocms/dashboard:user-mngmt-edit": {
+            title: string;
+            description: string;
+            header: string;
+            "header-delete-button": string;
+            "header-save-button": string;
+            "delete-modal-header": string;
+            "delete-modal-desc-1": string;
+            "delete-modal-desc-2": string;
+            "delete-modal-warning": string;
+            "user-info-header": string;
+            "user-info-email": string;
+            "user-info-username": string;
+            "user-info-website": string;
+            "user-info-created-at": string;
+            "user-info-updated-at": string;
+            "password-reset-button": string;
+            "password-reset-modal-header": string;
+            "password-reset-modal-desc-1": string;
+            "password-reset-modal-desc-2": string;
+            "password-reset-modal-link": string;
+            "edit-role-header": string;
+            "email-verification-status": string;
+            "social-accounts-header": string;
+            "social-accounts-non": string;
+            "api-tokens-header": string;
+            "api-tokens-delete-button": string;
+            "api-tokens-created": string;
+            "api-tokens-no-tokens": string;
+            "last-edit-pages-header": string;
+            "last-edit-pages-edited": string;
+            "last-edit-pages-no-edits": string;
+        };
+        "@studiocms/dashboard:plugin-settings": {
+            title: string;
+            description: string;
+            header: string;
+            "save-button": string;
+        };
+        "@studiocms/dashboard:content-sidebar": {
+            "input-placeholder-search": string;
+            "dropdown-create-page": string;
+            "dropdown-create-folder": string;
+            "items-divider": string;
+        };
+        "@studiocms/dashboard:content-header": {
+            title: string;
+            "edit-page-title": string;
+            "edit-folder-title": string;
+            "create-page-title": string;
+            "create-folder-title": string;
+            "delete-button": string;
+            "save-button": string;
+            "create-button": string;
+            "draft-button": string;
+            "publish-button": string;
+            "delete-modal-header": string;
+            "delete-modal-warning": string;
+            "delete-modal-desc-1": string;
+            "delete-modal-desc-2": string;
+            "delete-folder-modal-desc-1": string;
+            "delete-folder-modal-desc-2": string;
+        };
+        "@studiocms/dashboard:content-index": {
+            title: string;
+            description: string;
+            header: string;
+            placeholder: string;
+        };
+        "@studiocms/dashboard:content-diff": {
+            "view-page": string;
+            "page-metadata": string;
+            "page-content": string;
+            "revert-metadata": string;
+            "revert-content": string;
+            "revert-all": string;
+            "page-title": string;
+            "edited-by": string;
+            "edited-on": string;
+            "no-metadata-changes": string;
+        };
+        "@studiocms/dashboard:content-folder": {
+            "input-folder-name": string;
+            "input-folder-parent": string;
+        };
+        "@studiocms/dashboard:content-page": {
+            "tab-label-basic-info": string;
+            "tab-label-content": string;
+            "tab-label-diff": string;
+            "input-page-title": string;
+            "input-page-slug": string;
+            "input-page-description": string;
+            "input-page-hero-image": string;
+            "select-page-type": string;
+            "select-page-show-in-nav": string;
+            "select-page-parent-folder": string;
+            "select-page-draft": string;
+            "select-page-categories": string;
+            "select-page-tags": string;
+            "select-page-show-author": string;
+            "select-page-show-contributors": string;
+            "custom-page-type-fields-header": string;
+            "custom-page-types-description-new": string;
+            "diff-edited-by-1": string;
+            "diff-edited-by-2": string;
+            "diff-no-history": string;
+        };
+        "@studiocms/dashboard:404": {
+            title: string;
+            description: string;
+            "sub-description": string;
+            "back-button": string;
+        };
+        "@studiocms/dashboard:unverifiedEmail": {
+            title: string;
+            description: string;
+            "sub-description": string;
+            "resend-button": string;
+            "back-button": string;
+        };
+    };
+};
+/**
+ * Represents a translation record for StudioCMS.
+ *
+ * @property displayName - The human-readable name for the translation.
+ * @property translations - The translation data in the form of a ComponentsJSON object.
+ */
+export type StudioCMSTranslationRecord = typeof baseServerTranslations;
+/**
+ * Represents a translation entry in JSON format.
+ * Can be either a string (a translated value) or a nested object of translations.
+ * This allows for both flat and hierarchical translation structures.
+ */
+export type TranslationJSON = string | TranslationsJSON;
+/**
+ * The UI translations available in the StudioCMS app.
+ */
+export type UiTranslationKey = string;
+/**
+ * Represents a collection of translation entries, where each key is a locale or identifier,
+ * and the value is a `TranslationJSON` object containing the translations for that key.
+ *
+ * @remarks
+ * This interface is typically used to store or retrieve multiple sets of translations,
+ * organized by language or context.
+ *
+ * @example
+ * ```typescript
+ * const translations: TranslationsJSON = {
+ *   en: { greeting: "Hello" },
+ *   fr: { greeting: "Bonjour" }
+ * };
+ * ```
+ */
+export interface TranslationsJSON {
+    [key: string]: TranslationJSON;
+}
+/**
+ * Represents a mapping of component names to their respective translation objects.
+ *
+ * @remarks
+ * Each key in the object is a component name (as a string), and the value is a `TranslationsJSON`
+ * object containing the translations for that component.
+ *
+ * @example
+ * ```typescript
+ * const components: ComponentsJSON = {
+ *   header: { en: "Header", fr: "En-tête" },
+ *   footer: { en: "Footer", fr: "Pied de page" }
+ * };
+ * ```
+ */
+export type ComponentsJSON = StudioCMSTranslationRecord['translations'];
+/**
+ * Represents the server-side UI translations.
+ *
+ * This type maps each `UiTranslationKey` to its corresponding `StudioCMSTranslationRecord`,
+ * allowing for structured access to translation records for different UI elements.
+ *
+ * @see UiTranslationKey
+ * @see StudioCMSTranslationRecord
+ */
+export type ServerUiTranslations = Record<UiTranslationKey, StudioCMSTranslationRecord>;
+/**
+ * Represents a mapping of UI translation keys to their corresponding component translation JSON objects.
+ *
+ * @typeParam UiTranslationKey - The set of valid keys for UI translations.
+ * @typeParam ComponentsJSON - The shape of the translation data for each component.
+ */
+export type ClientUiTranslations = Record<UiTranslationKey, ComponentsJSON>;
+/**
+ * Represents an option for selecting a language in the UI.
+ *
+ * @property key - The translation key associated with the language option.
+ * @property value - The display value for the language option.
+ */
+export interface LanguageSelectorOption {
+    readonly key: UiTranslationKey;
+    readonly value: string;
+}
+/**
+ * An object containing server-side UI translations for supported locales.
+ *
+ * - The `en` property provides the base server translations for English.
+ * - Additional locale translations are spread from `nonBaseTranslations`.
+ *
+ * @remarks
+ * This constant is typed as `ServerUiTranslations` and marked as `const` for immutability.
+ */
+export declare const serverUiTranslations: ServerUiTranslations;
+/**
+ * The UI translations available in the StudioCMS app.
+ */
+export declare const uiTranslationsAvailable: UiTranslationKey[];
+/**
+ * Transforms the `serverUiTranslations` object into a `ClientUiTranslations` object
+ * by extracting only the `translations` property for each UI translation key.
+ *
+ * @remarks
+ * This reduces the server-side translation structure to a client-friendly format,
+ * mapping each `UiTranslationKey` to its corresponding translations object.
+ *
+ * @type {ClientUiTranslations}
+ */
+export declare const clientUiTranslations: ClientUiTranslations;
+/**
+ * The default language for the StudioCMS app.
+ */
+export declare const defaultLang: UiTranslationKey;
+/**
+ * Whether to show the default language in the url path.
+ */
+export declare const showDefaultLang: boolean;
+/**
+ * Generates an array of language selector options from the available server UI translations.
+ * Each option contains a `key` representing the language code and a `value` representing the display name of the language.
+ *
+ * @remarks
+ * This is typically used to populate language selection dropdowns in the UI.
+ *
+ * @returns An array of objects, each with `key` and `value` properties for language selection.
+ */
+export declare const languageSelectorOptions: LanguageSelectorOption[];

package/dist/virtuals/i18n/config.js

@@ -0,0 +1,29 @@
+import { availableTranslations } from "studiocms:i18n/virtual";
+const baseServerTranslations = (await import("./translations/en.json", { assert: { type: "json" } })).default;
+const serverUiTranslations = {
+  en: baseServerTranslations,
+  ...availableTranslations
+};
+const uiTranslationsAvailable = Object.keys(serverUiTranslations);
+const clientUiTranslations = Object.entries(
+  serverUiTranslations
+).reduce((acc, [key, value]) => {
+  acc[key] = value.translations;
+  return acc;
+}, {});
+const defaultLang = "en";
+const showDefaultLang = false;
+const languageSelectorOptions = Object.keys(serverUiTranslations).map((key) => {
+  const displayName = serverUiTranslations[key]?.displayName;
+  const value = typeof displayName === "string" && displayName.trim() ? displayName : String(key);
+  return { key, value };
+}).sort((a, b) => a.value.localeCompare(b.value, void 0, { sensitivity: "base" }));
+export {
+  baseServerTranslations,
+  clientUiTranslations,
+  defaultLang,
+  languageSelectorOptions,
+  serverUiTranslations,
+  showDefaultLang,
+  uiTranslationsAvailable
+};

package/dist/virtuals/i18n/server.d.ts

@@ -0,0 +1,116 @@
+/**
+ * This module handles internationalization (i18n) for the StudioCMS application on the server side.
+ *
+ * It provides utilities for loading and managing translation files, as well as functions for
+ * retrieving translated strings based on the current language context.
+ */
+import type { AstroGlobal } from 'astro';
+import { defaultLang } from './config.js';
+export { defaultLang };
+/**
+ * The UI translations available in the StudioCMS app.
+ */
+declare const uiTranslations: import("./config.js").ServerUiTranslations;
+/**
+ * Represents the type of UI translations.
+ * This type is derived from the structure of the `uiTranslations` object.
+ */
+export type UiTranslations = typeof uiTranslations;
+/**
+ * Represents the keys of the UiTranslations type.
+ * This type is used to define the possible keys for UI language translations.
+ */
+export type UiLanguageKeys = keyof UiTranslations;
+/**
+ * Represents the keys of the UI component translations for the 'en' locale.
+ * This type is derived from the 'translations' property of the 'UiTranslations' interface
+ * for the 'en' locale (Source of truth), ensuring that only valid translation keys are used.
+ */
+export type UiComponentKeys = keyof UiTranslations['en']['translations'];
+/**
+ * Represents the translation type for a specific UI component key (`T`)
+ * within a given language key (`L`) from the `uiTranslations` object.
+ *
+ * @typeParam L - The language key, constrained to `UiLanguageKeys`.
+ * @typeParam T - The UI component key, constrained to `UiComponentKeys`.
+ *
+ * @example
+ * // Get the translation type for the 'button' component in 'en' language:
+ * type ButtonTranslation = UiTranslationComponent<'en', 'button'>;
+ */
+type UiTranslationComponent<L extends UiLanguageKeys, T extends UiComponentKeys> = (typeof uiTranslations)[L]['translations'][T];
+/**
+ * Represents the set of valid translation keys for a specific UI component and language.
+ *
+ * @typeParam L - The type representing the available UI language keys.
+ * @typeParam T - The type representing the available UI component keys.
+ *
+ * This type resolves to the union of property names (keys) of the translation object
+ * for the given language (`L`) and component (`T`), as defined by `UiTranslationComponent`.
+ */
+type UiTranslationComponentKey<L extends UiLanguageKeys, T extends UiComponentKeys> = keyof UiTranslationComponent<L, T>;
+/**
+ * Retrieves a translation function for a given language and component.
+ *
+ * @param lang - The language key to use for translations.
+ * @param component - The component key to use for translations.
+ * @returns A function that takes a translation key and returns the corresponding translated string.
+ */
+export declare function useTranslations<L extends UiLanguageKeys, T extends UiComponentKeys>(lang: L, component: T): (key: UiTranslationComponentKey<L, T>) => string;
+/**
+ * Returns a function that translates a given path based on the provided language.
+ *
+ * @param lang - The language key to be used for translation.
+ * @returns A function that takes a path and an optional language key, and returns the translated path.
+ * If the language key is not provided, the default language key is used.
+ * If the language is the default language and `showDefaultLang` is false, the original path is returned.
+ * Otherwise, the path is prefixed with the language key.
+ */
+export declare function useTranslatedPath(lang: UiLanguageKeys): (path: string, l?: UiLanguageKeys) => string;
+/**
+ * Extracts the language key from the given URL's pathname.
+ *
+ * @param url - The URL object from which to extract the language key.
+ * @returns The language key if it exists in the `uiTranslations`, otherwise returns the default language key.
+ */
+export declare function getLangFromUrl(url: URL): string;
+/**
+ * Retrieves the current URL path, adjusting for language settings.
+ *
+ * This function checks if the URL path includes '/_server-islands'. If it does,
+ * it extracts the referer URL from the request headers and determines the current
+ * language from that URL. If the current language is the default language, it returns
+ * the pathname as is. Otherwise, it replaces the language segment in the pathname with '/'.
+ *
+ * If the URL path does not include '/_server-islands', it uses the Astro URL directly
+ * to determine the current language and adjust the pathname accordingly.
+ *
+ * @param {AstroGlobal} Astro - The global Astro object containing URL and request information.
+ */
+export declare function getCurrentURLPath(Astro: AstroGlobal): string;
+/**
+ * Function to switch the language of the current page.
+ *
+ * @param {AstroGlobal} Astro - The global Astro object.
+ */
+export declare function switchLanguage(Astro: AstroGlobal): (languageKey: UiLanguageKeys) => string;
+/**
+ * Example of how to use this i18n utils on a Static page
+ *
+ * @example
+ * ```ts
+ * export async function getStaticPaths() {
+ *	const paths = staticPaths();
+ *	return paths;
+ * }
+ * ```
+ *
+ * If the default language is hidden, the paths for the default language will be generated without the language prefix while all extra languages will have the prefix. (e.g. When `showDefaultLang` is false: `/en/page` will be `/page` and spanish will be `/es/page`)
+ *
+ * @returns An array of paths for all languages
+ */
+export declare const staticPaths: () => {
+    params: {
+        locale: string | undefined;
+    };
+}[];

package/dist/{lib/i18n/index.js → virtuals/i18n/server.js}

@@ -1,17 +1,11 @@
-import { defaultLang, showDefaultLang } from "./config.js";
-const uiTranslations = {
-  en: await import("./translations/en.json"),
-  de: await import("./translations/de.json"),
-  es: await import("./translations/es.json"),
-  fr: await import("./translations/fr.json")
-};
+import { defaultLang, serverUiTranslations, showDefaultLang } from "./config.js";
+const uiTranslations = serverUiTranslations;
 function useTranslations(lang, component) {
   return function t(key) {
-    const translation = uiTranslations[lang].translations[component][key];
-    if (translation === void 0 || translation === "") {
-      return uiTranslations[defaultLang].translations[component][key];
-    }
-    return translation;
+    const v = uiTranslations[lang]?.translations?.[component]?.[key];
+    if (typeof v === "string") return v;
+    const fb = uiTranslations[defaultLang]?.translations?.[component]?.[key];
+    return typeof fb === "string" ? fb : String(key);
   };
 }
 function useTranslatedPath(lang) {
@@ -19,12 +13,6 @@ function useTranslatedPath(lang) {
     return !showDefaultLang && l === defaultLang ? path : `/${l}${path}`;
   };
 }
-const languageSelectorOptions = Object.keys(uiTranslations).map((key) => {
-  return {
-    key,
-    value: uiTranslations[key].displayName
-  };
-});
 function getLangFromUrl(url) {
   const [, lang] = url.pathname.split("/");
   if (lang && lang in uiTranslations) return lang;
@@ -59,7 +47,6 @@ export {
   defaultLang,
   getCurrentURLPath,
   getLangFromUrl,
-  languageSelectorOptions,
   staticPaths,
   switchLanguage,
   useTranslatedPath,

package/dist/{lib → virtuals}/i18n/translations/de.json

@@ -98,7 +98,7 @@
       "api-tokens-modal-response-header": "Neuer Token",
       "api-tokens-modal-response-description": "Bitte speichere deinen neuen Token. Er wird nie wieder sichtbar sein.",
       "sync-with-libravatar": "Libravatar Synchronisieren",
-      "basic-avatar-url": "Avatar URL"
+      "basic-avatar-url": "Profilbild-URL"
     },
     "@studiocms/dashboard:password-reset": {
       "title": "Passwort zurücksetzen",

package/dist/virtuals/i18n/v-files.d.ts

@@ -0,0 +1,30 @@
+/**
+ * This file is responsible for managing translation files.
+ *
+ * It provides utilities to work with translation keys and their corresponding
+ * file paths.
+ *
+ * Note: The exported function is imported and used by the main index of the integration,
+ * to generate the list of available translation keys and inject them into a server/client
+ * friendly Vite virtual module.
+ */
+import type { ServerUiTranslations } from './config.js';
+/**
+ * An array of translation file keys derived from `availableTranslationFiles`.
+ * Each key is generated by removing the `.json` extension from the file name.
+ * Falsy values are filtered out from the resulting array.
+ *
+ * @example
+ * // If availableTranslationFiles = ['en.json', 'fr.json']
+ * // availableTranslationFileKeys = ['en', 'fr']
+ */
+export declare const availableTranslationFileKeys: string[];
+/**
+ * Loads and returns the available server-side UI translations, excluding English ('en').
+ * For each translation file key, reads the corresponding JSON file, checks its string values,
+ * and includes it in the results only if it passes the threshold check.
+ * Skips translation files with too many empty strings and logs a warning.
+ *
+ * @returns {ServerUiTranslations} An object mapping language keys to their translation records.
+ */
+export declare const availableTranslations: ServerUiTranslations;