studiocms 0.1.0-beta.10

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

@@ -0,0 +1,16 @@
+/**
+ * The UI translations available in the StudioCMS app.
+ */
+export declare const uiTranslationsAvailable: readonly ["en-us"];
+/**
+ * The UI translations available in the StudioCMS app.
+ */
+export type UiTranslationKey = (typeof uiTranslationsAvailable)[number];
+/**
+ * The default language for the StudioCMS app.
+ */
+export declare const defaultLang: UiTranslationKey;
+/**
+ * Whether to show the default language in the language switcher.
+ */
+export declare const showDefaultLang: boolean;

package/dist/lib/i18n/config.js

@@ -0,0 +1,8 @@
+const uiTranslationsAvailable = ["en-us"];
+const defaultLang = "en-us";
+const showDefaultLang = false;
+export {
+  defaultLang,
+  showDefaultLang,
+  uiTranslationsAvailable
+};

package/dist/lib/i18n/index.d.ts

@@ -0,0 +1,578 @@
+import type { AstroGlobal } from 'astro';
+/**
+ * The UI translations available in the StudioCMS app.
+ */
+declare const uiTranslations: {
+    readonly 'en-us': {
+        default: {
+            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;
+                };
+                "@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;
+                };
+                "@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;
+                };
+                "@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;
+                };
+                "@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;
+                    "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;
+                };
+                "@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;
+                };
+            };
+        };
+        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;
+            };
+            "@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;
+            };
+            "@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;
+            };
+            "@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;
+            };
+            "@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;
+                "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;
+            };
+            "@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;
+            };
+        };
+    };
+};
+/**
+ * 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-us' locale.
+ * This type is derived from the 'translations' property of the 'UiTranslations' interface
+ * for the 'en-us' locale (Source of truth), ensuring that only valid translation keys are used.
+ */
+export type UiComponentKeys = keyof UiTranslations['en-us']['translations'];
+type UiTranslationComponent<L extends UiLanguageKeys, T extends UiComponentKeys> = (typeof uiTranslations)[L]['translations'][T];
+type UiTranslationKey<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: UiTranslationKey<L, T>) => UiTranslationComponent<L, T>[UiTranslationKey<L, T>];
+/**
+ * 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?: string) => string;
+/**
+ * Generates an array of language selector options from the `uiTranslations` object.
+ * Each option contains a `key` and a `value` where:
+ * - `key` is a language key from `UiLanguageKeys`.
+ * - `value` is the display name of the language.
+ *
+ * @returns An array of objects representing language selector options.
+ */
+export declare const languageSelectorOptions: {
+    key: UiLanguageKeys;
+    value: 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): "en-us";
+/**
+ * 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;
+    };
+}[];
+export {};

package/dist/lib/i18n/index.js

@@ -0,0 +1,63 @@
+import { defaultLang, showDefaultLang } from "./config.js";
+const uiTranslations = {
+  "en-us": await import("./translations/en-us.json")
+};
+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;
+  };
+}
+function useTranslatedPath(lang) {
+  return function translatePath(path, l = 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;
+  return defaultLang;
+}
+function getCurrentURLPath(Astro) {
+  if (Astro.url.pathname.includes("/_server-islands")) {
+    const path2 = new URL(Astro.request.headers.get("referer") || "");
+    const currentLang2 = getLangFromUrl(path2);
+    return currentLang2 === defaultLang ? path2.pathname : path2.pathname.replace(`/${currentLang2}/`, "/");
+  }
+  const path = Astro.url;
+  const currentLang = getLangFromUrl(path);
+  return currentLang === defaultLang ? path.pathname : path.pathname.replace(`/${currentLang}/`, "/");
+}
+function switchLanguage(Astro) {
+  return function switcher(languageKey) {
+    const translatePath = useTranslatedPath(languageKey);
+    return translatePath(getCurrentURLPath(Astro));
+  };
+}
+const staticPaths = () => {
+  const paths = [];
+  if (!showDefaultLang) paths.push({ params: { locale: void 0 } });
+  for (const lang in uiTranslations) {
+    if (lang === defaultLang && !showDefaultLang) continue;
+    paths.push({ params: { locale: lang } });
+  }
+  return paths;
+};
+export {
+  getCurrentURLPath,
+  getLangFromUrl,
+  languageSelectorOptions,
+  staticPaths,
+  switchLanguage,
+  useTranslatedPath,
+  useTranslations
+};