@questpie/admin 1.1.1 → 2.0.0

package/dist/server/modules/admin/functions/translations.mjs

@@ -0,0 +1,125 @@
+import { getAdminMessagesForLocale, getSupportedAdminLocales } from "../../../i18n/index.mjs";
+import { z } from "zod";
+import { fn } from "questpie";
+
+//#region src/server/modules/admin/functions/translations.ts
+/**
+* Admin Translations Functions
+*
+* Functions for retrieving admin UI translations from the server.
+* The client fetches translations for its current UI locale.
+*
+* This enables:
+* - Single source of truth for all translations on server
+* - Dynamic locale switching without bundling all languages
+* - Custom messages via .messages() on QuestpieBuilder
+*/
+/**
+* Helper to get typed CMS app from handler context.
+*/
+function getApp(ctx) {
+	return ctx.app;
+}
+/**
+* Get admin locale config from CMS state.
+*/
+function getAdminLocaleConfig(cms) {
+	return cms.state?.adminLocale;
+}
+const getAdminTranslationsSchema = z.object({ locale: z.string() });
+const messageValueSchema = z.union([z.string(), z.object({
+	one: z.string(),
+	other: z.string()
+})]);
+const getAdminTranslationsOutputSchema = z.object({
+	locale: z.string(),
+	messages: z.record(z.string(), messageValueSchema),
+	fallbackLocale: z.string()
+});
+const getAdminLocalesSchema = z.object({}).optional();
+const getAdminLocalesOutputSchema = z.object({
+	locales: z.array(z.string()),
+	defaultLocale: z.string()
+});
+/**
+* Get admin UI translations for a specific locale.
+*
+* Merges:
+* 1. Built-in admin messages for the locale
+* 2. Custom messages from .messages() on QuestpieBuilder
+*
+* Custom messages override built-in messages with the same key.
+*
+* @example
+* ```ts
+* // Client fetches translations
+* const { messages, locale, fallbackLocale } = await client.functions.getAdminTranslations({
+*   locale: "sk",
+* });
+*
+* // messages contains all admin UI strings in Slovak
+* ```
+*/
+const getAdminTranslations = fn({
+	type: "query",
+	schema: getAdminTranslationsSchema,
+	outputSchema: getAdminTranslationsOutputSchema,
+	handler: async (ctx) => {
+		const cms = getApp(ctx);
+		const requestedLocale = ctx.input.locale;
+		const adminLocaleConfig = getAdminLocaleConfig(cms);
+		const supportedLocales = adminLocaleConfig?.locales ?? getSupportedAdminLocales();
+		const defaultLocale = adminLocaleConfig?.defaultLocale ?? "en";
+		const locale = supportedLocales.includes(requestedLocale) ? requestedLocale : defaultLocale;
+		const builtInMessages = getAdminMessagesForLocale(locale);
+		const fallbackMessages = locale !== defaultLocale ? getAdminMessagesForLocale(defaultLocale) : {};
+		const customFallbackMessages = locale !== defaultLocale ? cms.config.translations?.messages?.[defaultLocale] ?? {} : {};
+		const customMessages = cms.config.translations?.messages?.[locale] ?? {};
+		return {
+			locale,
+			messages: {
+				...fallbackMessages,
+				...customFallbackMessages,
+				...builtInMessages,
+				...customMessages
+			},
+			fallbackLocale: defaultLocale
+		};
+	}
+});
+/**
+* Get available admin UI locales.
+*
+* Returns locales configured via .adminLocale() or defaults to
+* all locales that have built-in message files.
+*
+* @example
+* ```ts
+* const { locales, defaultLocale } = await client.functions.getAdminLocales({});
+* // locales: ["en", "sk"]
+* // defaultLocale: "en"
+* ```
+*/
+const getAdminLocales = fn({
+	type: "query",
+	schema: getAdminLocalesSchema,
+	outputSchema: getAdminLocalesOutputSchema,
+	handler: async (ctx) => {
+		const adminLocaleConfig = getAdminLocaleConfig(getApp(ctx));
+		return {
+			locales: adminLocaleConfig?.locales ?? getSupportedAdminLocales(),
+			defaultLocale: adminLocaleConfig?.defaultLocale ?? "en"
+		};
+	}
+});
+/**
+* Bundle of translation-related functions.
+*/
+const translationFunctions = {
+	getAdminTranslations,
+	getAdminLocales
+};
+
+//#endregion
+export { getAdminLocales, getAdminTranslations, translationFunctions };
+//# sourceMappingURL=translations.mjs.map

package/dist/server/modules/admin/functions/translations.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"translations.mjs","names":[],"sources":["../../../../../src/server/modules/admin/functions/translations.ts"],"sourcesContent":["/**\n * Admin Translations Functions\n *\n * Functions for retrieving admin UI translations from the server.\n * The client fetches translations for its current UI locale.\n *\n * This enables:\n * - Single source of truth for all translations on server\n * - Dynamic locale switching without bundling all languages\n * - Custom messages via .messages() on QuestpieBuilder\n */\n\nimport { fn, type Questpie } from \"questpie\";\nimport { z } from \"zod\";\nimport type { AdminLocaleConfig } from \"../../../augmentation.js\";\nimport {\n  type AdminMessages,\n  getAdminMessagesForLocale,\n  getSupportedAdminLocales,\n} from \"../../../i18n/index.js\";\n\n// ============================================================================\n// Type Helpers\n// ============================================================================\n\n/**\n * Helper to get typed CMS app from handler context.\n */\nfunction getApp(ctx: { app: unknown }): Questpie<any> {\n  return ctx.app as Questpie<any>;\n}\n\n/**\n * Get admin locale config from CMS state.\n */\nfunction getAdminLocaleConfig(\n  cms: Questpie<any>,\n): AdminLocaleConfig | undefined {\n  return (cms as any).state?.adminLocale;\n}\n\n// ============================================================================\n// Schema Definitions\n// ============================================================================\n\nconst getAdminTranslationsSchema = z.object({\n  /** Requested locale code */\n  locale: z.string(),\n});\n\nconst messageValueSchema = z.union([\n  z.string(),\n  z.object({ one: z.string(), other: z.string() }),\n]);\n\nconst getAdminTranslationsOutputSchema = z.object({\n  /** Actual locale returned (may differ from requested if not supported) */\n  locale: z.string(),\n  /** Messages for the locale */\n  messages: z.record(z.string(), messageValueSchema),\n  /** Fallback locale */\n  fallbackLocale: z.string(),\n});\n\nconst getAdminLocalesSchema = z.object({}).optional();\n\nconst getAdminLocalesOutputSchema = z.object({\n  /** Available UI locales */\n  locales: z.array(z.string()),\n  /** Default UI locale */\n  defaultLocale: z.string(),\n});\n\n// ============================================================================\n// Functions\n// ============================================================================\n\n/**\n * Get admin UI translations for a specific locale.\n *\n * Merges:\n * 1. Built-in admin messages for the locale\n * 2. Custom messages from .messages() on QuestpieBuilder\n *\n * Custom messages override built-in messages with the same key.\n *\n * @example\n * ```ts\n * // Client fetches translations\n * const { messages, locale, fallbackLocale } = await client.functions.getAdminTranslations({\n *   locale: \"sk\",\n * });\n *\n * // messages contains all admin UI strings in Slovak\n * ```\n */\nexport const getAdminTranslations = fn({\n  type: \"query\",\n  schema: getAdminTranslationsSchema,\n  outputSchema: getAdminTranslationsOutputSchema,\n  handler: async (ctx) => {\n    const cms = getApp(ctx);\n    const input = ctx.input as z.infer<typeof getAdminTranslationsSchema>;\n    const requestedLocale = input.locale;\n\n    // Get admin locale config (set via .adminLocale())\n    const adminLocaleConfig = getAdminLocaleConfig(cms);\n    const supportedLocales =\n      adminLocaleConfig?.locales ?? getSupportedAdminLocales();\n    const defaultLocale = adminLocaleConfig?.defaultLocale ?? \"en\";\n\n    // Resolve locale - fall back to default if not supported\n    const locale = supportedLocales.includes(requestedLocale)\n      ? requestedLocale\n      : defaultLocale;\n\n    // Get built-in admin messages for this locale\n    const builtInMessages = getAdminMessagesForLocale(locale);\n\n    // Get fallback messages (English by default) so missing keys still resolve\n    const fallbackMessages =\n      locale !== defaultLocale\n        ? getAdminMessagesForLocale(defaultLocale)\n        : {};\n\n    // Get custom messages from .messages() on QuestpieBuilder\n    const customFallbackMessages =\n      locale !== defaultLocale\n        ? (cms.config.translations?.messages?.[defaultLocale] ?? {})\n        : {};\n    const customMessages = cms.config.translations?.messages?.[locale] ?? {};\n\n    // Merge: fallback → built-in → custom (later overrides earlier)\n    const messages: AdminMessages = {\n      ...fallbackMessages,\n      ...customFallbackMessages,\n      ...builtInMessages,\n      ...customMessages,\n    };\n\n    return {\n      locale,\n      messages,\n      fallbackLocale: defaultLocale,\n    };\n  },\n});\n\n/**\n * Get available admin UI locales.\n *\n * Returns locales configured via .adminLocale() or defaults to\n * all locales that have built-in message files.\n *\n * @example\n * ```ts\n * const { locales, defaultLocale } = await client.functions.getAdminLocales({});\n * // locales: [\"en\", \"sk\"]\n * // defaultLocale: \"en\"\n * ```\n */\nexport const getAdminLocales = fn({\n  type: \"query\",\n  schema: getAdminLocalesSchema,\n  outputSchema: getAdminLocalesOutputSchema,\n  handler: async (ctx) => {\n    const cms = getApp(ctx);\n    const adminLocaleConfig = getAdminLocaleConfig(cms);\n\n    return {\n      locales: adminLocaleConfig?.locales ?? getSupportedAdminLocales(),\n      defaultLocale: adminLocaleConfig?.defaultLocale ?? \"en\",\n    };\n  },\n});\n\n// ============================================================================\n// Export Bundle\n// ============================================================================\n\n/**\n * Bundle of translation-related functions.\n */\nexport const translationFunctions = {\n  getAdminTranslations,\n  getAdminLocales,\n} as const;\n"],"mappings":";;;;;;;;;;;;;;;;;;;AA4BA,SAAS,OAAO,KAAsC;AACpD,QAAO,IAAI;;;;;AAMb,SAAS,qBACP,KAC+B;AAC/B,QAAQ,IAAY,OAAO;;AAO7B,MAAM,6BAA6B,EAAE,OAAO,EAE1C,QAAQ,EAAE,QAAQ,EACnB,CAAC;AAEF,MAAM,qBAAqB,EAAE,MAAM,CACjC,EAAE,QAAQ,EACV,EAAE,OAAO;CAAE,KAAK,EAAE,QAAQ;CAAE,OAAO,EAAE,QAAQ;CAAE,CAAC,CACjD,CAAC;AAEF,MAAM,mCAAmC,EAAE,OAAO;CAEhD,QAAQ,EAAE,QAAQ;CAElB,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,mBAAmB;CAElD,gBAAgB,EAAE,QAAQ;CAC3B,CAAC;AAEF,MAAM,wBAAwB,EAAE,OAAO,EAAE,CAAC,CAAC,UAAU;AAErD,MAAM,8BAA8B,EAAE,OAAO;CAE3C,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC;CAE5B,eAAe,EAAE,QAAQ;CAC1B,CAAC;;;;;;;;;;;;;;;;;;;;AAyBF,MAAa,uBAAuB,GAAG;CACrC,MAAM;CACN,QAAQ;CACR,cAAc;CACd,SAAS,OAAO,QAAQ;EACtB,MAAM,MAAM,OAAO,IAAI;EAEvB,MAAM,kBADQ,IAAI,MACY;EAG9B,MAAM,oBAAoB,qBAAqB,IAAI;EACnD,MAAM,mBACJ,mBAAmB,WAAW,0BAA0B;EAC1D,MAAM,gBAAgB,mBAAmB,iBAAiB;EAG1D,MAAM,SAAS,iBAAiB,SAAS,gBAAgB,GACrD,kBACA;EAGJ,MAAM,kBAAkB,0BAA0B,OAAO;EAGzD,MAAM,mBACJ,WAAW,gBACP,0BAA0B,cAAc,GACxC,EAAE;EAGR,MAAM,yBACJ,WAAW,gBACN,IAAI,OAAO,cAAc,WAAW,kBAAkB,EAAE,GACzD,EAAE;EACR,MAAM,iBAAiB,IAAI,OAAO,cAAc,WAAW,WAAW,EAAE;AAUxE,SAAO;GACL;GACA,UAT8B;IAC9B,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACJ;GAKC,gBAAgB;GACjB;;CAEJ,CAAC;;;;;;;;;;;;;;AAeF,MAAa,kBAAkB,GAAG;CAChC,MAAM;CACN,QAAQ;CACR,cAAc;CACd,SAAS,OAAO,QAAQ;EAEtB,MAAM,oBAAoB,qBADd,OAAO,IAAI,CAC4B;AAEnD,SAAO;GACL,SAAS,mBAAmB,WAAW,0BAA0B;GACjE,eAAe,mBAAmB,iBAAiB;GACpD;;CAEJ,CAAC;;;;AASF,MAAa,uBAAuB;CAClC;CACA;CACD"}

package/dist/server/modules/admin/functions/widget-data.d.mts

@@ -0,0 +1,33 @@
+import * as questpie15929 from "questpie";
+
+//#region src/server/modules/admin/functions/widget-data.d.ts
+
+/**
+ * Widget Data Functions
+ *
+ * Provides server-side data fetching for widgets that declare a fetchFn.
+ * Called by the client when a widget has `hasFetchFn: true`.
+ */
+/**
+ * Fetch data for a server-side widget by its ID.
+ *
+ * Looks up the widget in the dashboard config, evaluates its access rule,
+ * and executes its fetchFn with server context.
+ *
+ * @example
+ * ```ts
+ * // Client usage (via useServerWidgetData hook)
+ * const data = await client.rpc.fetchWidgetData({ widgetId: "my-widget" });
+ * ```
+ */
+declare const fetchWidgetData: questpie15929.JsonFunctionDefinition<{
+  widgetId: string;
+}, any>;
+declare const widgetDataFunctions: {
+  readonly fetchWidgetData: questpie15929.JsonFunctionDefinition<{
+    widgetId: string;
+  }, any>;
+};
+//#endregion
+export { fetchWidgetData, widgetDataFunctions };
+//# sourceMappingURL=widget-data.d.mts.map

package/dist/server/modules/admin/functions/widget-data.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"widget-data.d.mts","names":[],"sources":["../../../../../src/server/modules/admin/functions/widget-data.ts"],"sourcesContent":[],"mappings":";;;;;;;AA4DA;AAmDA;;;;;;;;;;;;;;cAnDa,iBA6CX,aAAA,CA7C0B;;;cAmDf;4BAEH,aAAA,CAAA"}

package/dist/server/modules/admin/functions/widget-data.mjs

@@ -0,0 +1,70 @@
+import { z } from "zod";
+import { fn } from "questpie";
+
+//#region src/server/modules/admin/functions/widget-data.ts
+/**
+* Widget Data Functions
+*
+* Provides server-side data fetching for widgets that declare a fetchFn.
+* Called by the client when a widget has `hasFetchFn: true`.
+*/
+/**
+* Find a widget by ID in the dashboard tree (searches raw server config
+* which still has fetchFn attached).
+*/
+function findWidgetById(items, id) {
+	for (const item of items) if (item.type === "section") {
+		const found = findWidgetById(item.items || [], id);
+		if (found) return found;
+	} else if (item.type === "tabs") for (const tab of item.tabs || []) {
+		const found = findWidgetById(tab.items || [], id);
+		if (found) return found;
+	}
+	else if (item.id === id) return item;
+	return null;
+}
+const fetchWidgetDataSchema = z.object({ widgetId: z.string() });
+/**
+* Fetch data for a server-side widget by its ID.
+*
+* Looks up the widget in the dashboard config, evaluates its access rule,
+* and executes its fetchFn with server context.
+*
+* @example
+* ```ts
+* // Client usage (via useServerWidgetData hook)
+* const data = await client.rpc.fetchWidgetData({ widgetId: "my-widget" });
+* ```
+*/
+const fetchWidgetData = fn({
+	type: "query",
+	schema: fetchWidgetDataSchema,
+	outputSchema: z.unknown(),
+	handler: async (ctx) => {
+		const cms = ctx.app;
+		const dashboard = (cms.state || {}).dashboard;
+		if (!dashboard?.items) throw new Error("No dashboard configured");
+		const widget = findWidgetById(dashboard.items, ctx.input.widgetId);
+		if (!widget) throw new Error(`Widget "${ctx.input.widgetId}" not found`);
+		if (!widget.fetchFn) throw new Error(`Widget "${ctx.input.widgetId}" has no fetchFn`);
+		if (widget.access !== void 0) {
+			if ((typeof widget.access === "function" ? await widget.access({
+				app: cms,
+				db: ctx.db,
+				session: ctx.session,
+				locale: ctx.locale
+			}) : widget.access) === false) throw new Error("Access denied");
+		}
+		return widget.fetchFn({
+			app: cms,
+			db: ctx.db,
+			session: ctx.session,
+			locale: ctx.locale
+		});
+	}
+});
+const widgetDataFunctions = { fetchWidgetData };
+
+//#endregion
+export { fetchWidgetData, widgetDataFunctions };
+//# sourceMappingURL=widget-data.mjs.map

package/dist/server/modules/admin/functions/widget-data.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"widget-data.mjs","names":[],"sources":["../../../../../src/server/modules/admin/functions/widget-data.ts"],"sourcesContent":["/**\n * Widget Data Functions\n *\n * Provides server-side data fetching for widgets that declare a fetchFn.\n * Called by the client when a widget has `hasFetchFn: true`.\n */\n\nimport { fn, type Questpie } from \"questpie\";\nimport { z } from \"zod\";\nimport type { ServerDashboardItem } from \"../../../augmentation.js\";\n\n// ============================================================================\n// Helpers\n// ============================================================================\n\n/**\n * Find a widget by ID in the dashboard tree (searches raw server config\n * which still has fetchFn attached).\n */\nfunction findWidgetById(items: ServerDashboardItem[], id: string): any | null {\n  for (const item of items) {\n    if (item.type === \"section\") {\n      const found = findWidgetById((item as any).items || [], id);\n      if (found) return found;\n    } else if (item.type === \"tabs\") {\n      for (const tab of (item as any).tabs || []) {\n        const found = findWidgetById(tab.items || [], id);\n        if (found) return found;\n      }\n    } else if ((item as any).id === id) {\n      return item;\n    }\n  }\n  return null;\n}\n\n// ============================================================================\n// Schema\n// ============================================================================\n\nconst fetchWidgetDataSchema = z.object({\n  widgetId: z.string(),\n});\n\n// ============================================================================\n// Function\n// ============================================================================\n\n/**\n * Fetch data for a server-side widget by its ID.\n *\n * Looks up the widget in the dashboard config, evaluates its access rule,\n * and executes its fetchFn with server context.\n *\n * @example\n * ```ts\n * // Client usage (via useServerWidgetData hook)\n * const data = await client.rpc.fetchWidgetData({ widgetId: \"my-widget\" });\n * ```\n */\nexport const fetchWidgetData = fn({\n  type: \"query\",\n  schema: fetchWidgetDataSchema,\n  outputSchema: z.unknown(),\n  handler: async (ctx) => {\n    const cms = ctx.app as Questpie<any>;\n    const state = (cms as any).state || {};\n    const dashboard = state.dashboard;\n\n    if (!dashboard?.items) {\n      throw new Error(\"No dashboard configured\");\n    }\n\n    const widget = findWidgetById(dashboard.items, ctx.input.widgetId);\n    if (!widget) {\n      throw new Error(`Widget \"${ctx.input.widgetId}\" not found`);\n    }\n    if (!widget.fetchFn) {\n      throw new Error(`Widget \"${ctx.input.widgetId}\" has no fetchFn`);\n    }\n\n    // Evaluate per-widget access (if defined)\n    if (widget.access !== undefined) {\n      const accessResult =\n        typeof widget.access === \"function\"\n          ? await widget.access({\n              app: cms,\n              db: (ctx as any).db,\n              session: (ctx as any).session,\n              locale: (ctx as any).locale,\n            })\n          : widget.access;\n      if (accessResult === false) {\n        throw new Error(\"Access denied\");\n      }\n    }\n\n    // Execute fetchFn with server context\n    return widget.fetchFn({\n      app: cms,\n      db: (ctx as any).db,\n      session: (ctx as any).session,\n      locale: (ctx as any).locale,\n    });\n  },\n});\n\n// ============================================================================\n// Export Bundle\n// ============================================================================\n\nexport const widgetDataFunctions = {\n  fetchWidgetData,\n} as const;\n"],"mappings":";;;;;;;;;;;;;;AAmBA,SAAS,eAAe,OAA8B,IAAwB;AAC5E,MAAK,MAAM,QAAQ,MACjB,KAAI,KAAK,SAAS,WAAW;EAC3B,MAAM,QAAQ,eAAgB,KAAa,SAAS,EAAE,EAAE,GAAG;AAC3D,MAAI,MAAO,QAAO;YACT,KAAK,SAAS,OACvB,MAAK,MAAM,OAAQ,KAAa,QAAQ,EAAE,EAAE;EAC1C,MAAM,QAAQ,eAAe,IAAI,SAAS,EAAE,EAAE,GAAG;AACjD,MAAI,MAAO,QAAO;;UAEV,KAAa,OAAO,GAC9B,QAAO;AAGX,QAAO;;AAOT,MAAM,wBAAwB,EAAE,OAAO,EACrC,UAAU,EAAE,QAAQ,EACrB,CAAC;;;;;;;;;;;;;AAkBF,MAAa,kBAAkB,GAAG;CAChC,MAAM;CACN,QAAQ;CACR,cAAc,EAAE,SAAS;CACzB,SAAS,OAAO,QAAQ;EACtB,MAAM,MAAM,IAAI;EAEhB,MAAM,aADS,IAAY,SAAS,EAAE,EACd;AAExB,MAAI,CAAC,WAAW,MACd,OAAM,IAAI,MAAM,0BAA0B;EAG5C,MAAM,SAAS,eAAe,UAAU,OAAO,IAAI,MAAM,SAAS;AAClE,MAAI,CAAC,OACH,OAAM,IAAI,MAAM,WAAW,IAAI,MAAM,SAAS,aAAa;AAE7D,MAAI,CAAC,OAAO,QACV,OAAM,IAAI,MAAM,WAAW,IAAI,MAAM,SAAS,kBAAkB;AAIlE,MAAI,OAAO,WAAW,QAUpB;QARE,OAAO,OAAO,WAAW,aACrB,MAAM,OAAO,OAAO;IAClB,KAAK;IACL,IAAK,IAAY;IACjB,SAAU,IAAY;IACtB,QAAS,IAAY;IACtB,CAAC,GACF,OAAO,YACQ,MACnB,OAAM,IAAI,MAAM,gBAAgB;;AAKpC,SAAO,OAAO,QAAQ;GACpB,KAAK;GACL,IAAK,IAAY;GACjB,SAAU,IAAY;GACtB,QAAS,IAAY;GACtB,CAAC;;CAEL,CAAC;AAMF,MAAa,sBAAsB,EACjC,iBACD"}