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

package/dist/{lib → virtuals}/auth/verify-email.js

@@ -3,20 +3,19 @@ import { StudioCMSRoutes } from "studiocms:lib";
 import { Mailer } from "studiocms:mailer";
 import getTemplate from "studiocms:mailer/templates";
 import { SDKCoreJs as sdk } from "studiocms:sdk";
-import { Data, Effect } from "effect";
 import { CMSNotificationSettingsId } from "../../consts.js";
-import { genLogger, pipeLogger } from "../effects/logger.js";
+import { Data, Effect, genLogger, pipeLogger } from "../../effect.js";
 class VerifyEmailError extends Data.TaggedError("VerifyEmailError") {
 }
 class VerifyEmail extends Effect.Service()(
-  "studiocms/lib/auth/verify-email/VerifyEmail",
+  "studiocms/virtuals/auth/verify-email/VerifyEmail",
   {
-    effect: genLogger("studiocms/lib/auth/verify-email/VerifyEmail.effect")(function* () {
+    effect: genLogger("studiocms/virtuals/auth/verify-email/VerifyEmail.effect")(function* () {
       const MailService = yield* Mailer;
-      const getMailerStatus = () => pipeLogger("studiocms/lib/auth/verify-email/VerifyEmail.getMailerStatus")(
+      const getMailerStatus = () => pipeLogger("studiocms/virtuals/auth/verify-email/VerifyEmail.getMailerStatus")(
         MailService.isEnabled
       );
-      const getSettings = () => genLogger("studiocms/lib/auth/verify-email/VerifyEmail.getSettings")(function* () {
+      const getSettings = () => genLogger("studiocms/virtuals/auth/verify-email/VerifyEmail.getSettings")(function* () {
         const settings = yield* sdk.GET.databaseTable.notificationSettings();
         if (!settings) {
           return {
@@ -29,7 +28,7 @@ class VerifyEmail extends Effect.Service()(
         }
         return settings;
       });
-      const isEmailVerificationEnabled = () => genLogger("studiocms/lib/auth/verify-email/VerifyEmail.isEmailVerificationEnabled")(
+      const isEmailVerificationEnabled = () => genLogger("studiocms/virtuals/auth/verify-email/VerifyEmail.isEmailVerificationEnabled")(
         function* () {
           const mailer = yield* getMailerStatus();
           const settings = yield* getSettings();
@@ -37,19 +36,19 @@ class VerifyEmail extends Effect.Service()(
           return settings.emailVerification;
         }
       );
-      const getEmailVerificationRequest = (id) => pipeLogger("studiocms/lib/auth/verify-email/VerifyEmail.getEmailVerificationRequest")(
+      const getEmailVerificationRequest = (id) => pipeLogger("studiocms/virtuals/auth/verify-email/VerifyEmail.getEmailVerificationRequest")(
         sdk.AUTH.verifyEmail.get(id)
       );
-      const deleteEmailVerificationRequest = (id) => pipeLogger("studiocms/lib/auth/verify-email/VerifyEmail.deleteEmailVerificationRequest")(
-        sdk.AUTH.verifyEmail.delete(id)
-      );
-      const createEmailVerificationRequest = (userId) => genLogger("studiocms/lib/auth/verify-email/VerifyEmail.createEmailVerificationRequest")(
-        function* () {
-          yield* deleteEmailVerificationRequest(userId);
-          return yield* sdk.AUTH.verifyEmail.create(userId);
-        }
-      );
-      const generateUrl = (base, path, params) => pipeLogger("studiocms/lib/auth/verify-email/VerifyEmail.generateUrl")(
+      const deleteEmailVerificationRequest = (id) => pipeLogger(
+        "studiocms/virtuals/auth/verify-email/VerifyEmail.deleteEmailVerificationRequest"
+      )(sdk.AUTH.verifyEmail.delete(id));
+      const createEmailVerificationRequest = (userId) => genLogger(
+        "studiocms/virtuals/auth/verify-email/VerifyEmail.createEmailVerificationRequest"
+      )(function* () {
+        yield* deleteEmailVerificationRequest(userId);
+        return yield* sdk.AUTH.verifyEmail.create(userId);
+      });
+      const generateUrl = (base, path, params) => pipeLogger("studiocms/virtuals/auth/verify-email/VerifyEmail.generateUrl")(
         Effect.try({
           try: () => {
             const url = new URL(path, base);
@@ -61,7 +60,7 @@ class VerifyEmail extends Effect.Service()(
           catch: (cause) => new VerifyEmailError({ message: `URL generation error: ${cause}` })
         })
       );
-      const sendVerificationEmail = (userId, isOAuth = false) => genLogger("studiocms/lib/auth/verify-email/VerifyEmail.sendVerificationEmail")(
+      const sendVerificationEmail = (userId, isOAuth = false) => genLogger("studiocms/virtuals/auth/verify-email/VerifyEmail.sendVerificationEmail")(
         function* () {
           const mailer = yield* getMailerStatus();
           const settings = yield* getSettings();
@@ -99,7 +98,7 @@ class VerifyEmail extends Effect.Service()(
           return mailResponse;
         }
       );
-      const isEmailVerified = (user) => genLogger("studiocms/lib/auth/verify-email/VerifyEmail.isEmailVerified")(function* () {
+      const isEmailVerified = (user) => genLogger("studiocms/virtuals/auth/verify-email/VerifyEmail.isEmailVerified")(function* () {
         if (!user) return false;
         const mailer = yield* getMailerStatus();
         const settings = yield* getSettings();

package/dist/virtuals/components/Generator.astro

@@ -0,0 +1,5 @@
+---
+---
+<meta name="generator" content={Astro.generator} />
+<meta name="generator" content={Astro.locals.StudioCMS.SCMSGenerator} />
+<meta name="generator" content={Astro.locals.StudioCMS.SCMSUiGenerator} />

package/{src → dist/virtuals}/components/Renderer.astro

@@ -1,7 +1,7 @@
 ---
 import { pluginRenderers } from 'studiocms:plugins/renderers';
 import * as renderers from 'virtual:studiocms/plugins/renderers';
-import type { PluginPageTypeRendererProps } from '../types.js';
+import type { PluginPageTypeRendererProps } from '../../types.js';
 
 interface Props extends PluginPageTypeRendererProps {}
 

package/{src/lib → dist/virtuals}/i18n/LanguageSelector.astro

@@ -1,5 +1,5 @@
 ---
-import { languageSelectorOptions } from './index.js';
+import { languageSelectorOptions } from './config.js';
 
 // TODO: Update the language selector's styles to match StudioCMS's new design
 ---

package/dist/{lib → virtuals}/i18n/client.d.ts

@@ -1,5 +1,15 @@
+/**
+ * This module handles internationalization (i18n) for the StudioCMS application on the client 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 Messages, type Translations } from '@nanostores/i18n';
 import { defaultLang, type UiTranslationKey, uiTranslationsAvailable } from './config.js';
+export { defaultLang, type UiTranslationKey, uiTranslationsAvailable };
+/**
+ * The base translation object containing all translations for the default language.
+ */
 export declare const baseTranslation: {
     "@studiocms/auth:login": {
         title: string;
@@ -293,11 +303,43 @@ export declare const baseTranslation: {
         "back-button": string;
     };
 };
-export { defaultLang, type UiTranslationKey, uiTranslationsAvailable };
-export declare const $localeSettings: import("nanostores").WritableAtom<"en" | "de" | "es" | "fr" | undefined>;
-export declare const $locale: import("@nanostores/i18n").LocaleStore<"en" | "de" | "es" | "fr">;
+/**
+ * A persistent atom representing the user's locale settings.
+ */
+export declare const $localeSettings: import("nanostores").WritableAtom<string | undefined>;
+/**
+ * A locale store derived from the user's locale settings and browser detection.
+ */
+export declare const $locale: import("@nanostores/i18n").LocaleStore<string>;
+/**
+ * A formatter function for the current locale.
+ */
 export declare const format: import("nanostores").ReadableAtom<import("@nanostores/i18n").Formatter>;
-export declare const $i18n: import("@nanostores/i18n").I18n<"en" | "de" | "es" | "fr">;
+/**
+ * An i18n (internationalization) utility instance for client-side usage.
+ *
+ * @remarks
+ * This instance is created using the `createI18n` function, initialized with the current locale and a base locale.
+ * It provides a `get` method to asynchronously retrieve translations for a given UI translation key from the `localeMap`.
+ *
+ * @example
+ * ```typescript
+ * const translation = await $i18n.get('welcome_message');
+ * ```
+ *
+ * @see createI18n
+ *
+ * @param $locale - The current locale store or value.
+ * @param defaultLang - The default language to use as a base locale.
+ * @param localeMap - An object mapping translation keys to their localized strings.
+ */
+export declare const $i18n: import("@nanostores/i18n").I18n<string>;
+/**
+ * Updates the document's title, meta description, and language attribute based on the provided component and language.
+ *
+ * @param comp - An object containing the `title` and `description` properties to update the document's title and meta description.
+ * @param lang - The language code to set as the value of the document's `lang` attribute.
+ */
 export declare const documentUpdater: (comp: any, lang: string) => void;
 type BaseTranslation = typeof baseTranslation;
 type BaseTranslationKeys = keyof BaseTranslation;
@@ -661,8 +703,62 @@ export declare const makeTranslation: <Body extends Translations>(currentPage: B
         focus(options?: FocusOptions): void;
     };
 };
+/**
+ * Updates the label text for a given form element with a translated string.
+ *
+ * Searches for a `<label>` element associated with the specified element ID (`el`)
+ * and updates its child element with the class `.label` to display the provided translation.
+ * If the label's inner HTML matches the `requiredLabelRegex`, it appends a required star indicator.
+ *
+ * @param el - The ID of the form element whose label should be updated.
+ * @param translation - The translated string to set as the label's text.
+ */
 export declare const updateElmLabel: (el: string, translation: string) => void;
+/**
+ * Updates the placeholder text of an input element with the specified ID.
+ *
+ * @param el - The ID of the input element whose placeholder should be updated.
+ * @param translation - The new placeholder text to set for the input element.
+ *
+ * @remarks
+ * This function queries the DOM for an input element with the given ID and sets its
+ * `placeholder` property to the provided translation string.
+ *
+ * @throws {TypeError} If no element with the specified ID is found, or if the element is not an input.
+ */
 export declare const updateElmPlaceholder: (el: string, translation: string) => void;
+/**
+ * Updates the label of a select element with a translated string.
+ *
+ * Finds the corresponding `<label>` element for the given select element by its `for` attribute,
+ * and updates its content with the provided translation. If the label contains a required field indicator
+ * (as determined by `requiredLabelRegex`), it preserves the required star (`*`) in the label.
+ *
+ * @param el - The base ID of the select element (without the `-select-btn` suffix).
+ * @param translation - The translated string to set as the label's text.
+ */
 export declare const updateSelectElmLabel: (el: string, translation: string) => void;
+/**
+ * Updates the label text for a toggle element with a given translation.
+ *
+ * This function locates the `<label>` element associated with the provided element ID (`el`),
+ * then finds the corresponding `<span>` inside the label with the ID `label-${el}`.
+ * If the span's inner HTML matches the `requiredLabelRegex`, it updates the span's inner HTML
+ * to include the translated text and a required star indicator. Otherwise, it simply updates
+ * the span's text content with the translation.
+ *
+ * @param el - The ID of the element whose label should be updated.
+ * @param translation - The translated text to set as the label.
+ */
 export declare const updateToggleElmLabel: (el: string, translation: string) => void;
+/**
+ * Updates the text content of the page header's title element with the provided translation.
+ *
+ * @param translation - The translated string to set as the page title.
+ *
+ * @remarks
+ * This function selects the element with the class `.page-header` and then finds its child
+ * with the class `.page-title`, updating its text content to the given translation.
+ * It assumes that both elements exist in the DOM.
+ */
 export declare const pageHeaderUpdater: (translation: string) => void;

package/dist/{lib → virtuals}/i18n/client.js

@@ -5,14 +5,14 @@ import {
   localeFrom
 } from "@nanostores/i18n";
 import { persistentAtom } from "@nanostores/persistent";
-import { defaultLang, uiTranslationsAvailable } from "./config.js";
-const baseTranslation = (await import("./translations/en.json")).translations;
-const localeMap = {
-  en: baseTranslation,
-  de: (await import("./translations/de.json")).translations,
-  es: (await import("./translations/es.json")).translations,
-  fr: (await import("./translations/fr.json")).translations
-};
+import {
+  baseServerTranslations,
+  clientUiTranslations,
+  defaultLang,
+  uiTranslationsAvailable
+} from "./config.js";
+const baseTranslation = baseServerTranslations.translations;
+const localeMap = clientUiTranslations;
 const $localeSettings = persistentAtom(
   "studiocms-i18n-locale",
   defaultLang
@@ -22,14 +22,15 @@ const $locale = localeFrom(
   // User’s locale from localStorage
   browser({
     // or browser’s locale auto-detect
-    available: uiTranslationsAvailable
+    available: uiTranslationsAvailable,
+    fallback: defaultLang
   })
 );
 const format = formatter($locale);
 const $i18n = createI18n($locale, {
   baseLocale: defaultLang,
   get: async (code) => {
-    return localeMap[code];
+    return localeMap[code] ?? localeMap[defaultLang];
   }
 });
 const documentUpdater = (comp, lang) => {