@questpie/admin 1.1.1 → 3.0.0

package/dist/client/hooks/use-global-meta.mjs

@@ -0,0 +1,105 @@
+import { selectClient, useAdminStore } from "../runtime/provider.mjs";
+import { c } from "react/compiler-runtime";
+import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
+
+//#region src/client/hooks/use-global-meta.ts
+/**
+* Hook for fetching global metadata from the backend
+*
+* Used to get introspection info about globals like:
+* - Whether timestamps are enabled
+* - Whether versioning is enabled
+* - Localized fields
+* - Virtual fields
+*/
+/**
+* Hook to fetch global metadata from the backend
+*
+* Returns metadata useful for building dynamic UIs:
+* - timestamps: Whether createdAt/updatedAt are enabled
+* - versioning: Whether versioning is enabled
+* - localizedFields: Fields that support i18n
+* - virtualFields: Fields that are computed
+*
+* @example
+* ```tsx
+* const { data: meta } = useGlobalMeta("siteSettings");
+*
+* if (meta?.timestamps) {
+*   console.log("Timestamps enabled for this global");
+* }
+* ```
+*/
+function useGlobalMeta(global, queryOptions) {
+	const $ = c(9);
+	const client = useAdminStore(selectClient);
+	let t0;
+	if ($[0] !== global) {
+		t0 = getGlobalMetaQueryKey(global);
+		$[0] = global;
+		$[1] = t0;
+	} else t0 = $[1];
+	let t1;
+	if ($[2] !== client || $[3] !== global) {
+		t1 = async () => client.globals[global].meta();
+		$[2] = client;
+		$[3] = global;
+		$[4] = t1;
+	} else t1 = $[4];
+	let t2;
+	if ($[5] !== queryOptions || $[6] !== t0 || $[7] !== t1) {
+		t2 = {
+			queryKey: t0,
+			queryFn: t1,
+			staleTime: 3e5,
+			gcTime: 18e5,
+			...queryOptions
+		};
+		$[5] = queryOptions;
+		$[6] = t0;
+		$[7] = t1;
+		$[8] = t2;
+	} else t2 = $[8];
+	return useQuery(t2);
+}
+/**
+* Query key for global meta
+* Useful for prefetching or invalidation
+*/
+function getGlobalMetaQueryKey(global) {
+	return [
+		"questpie",
+		"globals",
+		global,
+		"meta"
+	];
+}
+/**
+* Query options factory for global metadata
+* Can be used with TanStack Query's prefetching in loaders or with useSuspenseQuery
+*
+* @example
+* ```ts
+* // In TanStack Start loader
+* export const Route = createFileRoute("/admin/globals/:name")({
+*   loader: async ({ context, params }) => {
+*     await context.queryClient.ensureQueryData(
+*       getGlobalMetaQueryOptions(params.name, context.client)
+*     );
+*   },
+* });
+* ```
+*/
+function getGlobalMetaQueryOptions(global, client) {
+	return {
+		queryKey: getGlobalMetaQueryKey(global),
+		queryFn: async () => {
+			return client.globals[global].meta();
+		},
+		staleTime: 300 * 1e3,
+		gcTime: 1800 * 1e3
+	};
+}
+
+//#endregion
+export { getGlobalMetaQueryOptions, useGlobalMeta };

package/dist/client/hooks/use-global-schema.mjs

@@ -0,0 +1,53 @@
+import { selectClient, useAdminStore } from "../runtime/provider.mjs";
+import { c } from "react/compiler-runtime";
+import { useQuery } from "@tanstack/react-query";
+
+//#region src/client/hooks/use-global-schema.ts
+/**
+* Hook for fetching global schema from the backend
+*
+* Returns introspection data including fields, access, and validation.
+*/
+function useGlobalSchema(global, queryOptions) {
+	const $ = c(9);
+	const client = useAdminStore(selectClient);
+	let t0;
+	if ($[0] !== global) {
+		t0 = getGlobalSchemaQueryKey(global);
+		$[0] = global;
+		$[1] = t0;
+	} else t0 = $[1];
+	let t1;
+	if ($[2] !== client || $[3] !== global) {
+		t1 = async () => client.globals[global].schema();
+		$[2] = client;
+		$[3] = global;
+		$[4] = t1;
+	} else t1 = $[4];
+	let t2;
+	if ($[5] !== queryOptions || $[6] !== t0 || $[7] !== t1) {
+		t2 = {
+			queryKey: t0,
+			queryFn: t1,
+			staleTime: 3e5,
+			gcTime: 18e5,
+			...queryOptions
+		};
+		$[5] = queryOptions;
+		$[6] = t0;
+		$[7] = t1;
+		$[8] = t2;
+	} else t2 = $[8];
+	return useQuery(t2);
+}
+function getGlobalSchemaQueryKey(global) {
+	return [
+		"questpie",
+		"globals",
+		global,
+		"schema"
+	];
+}
+
+//#endregion
+export { useGlobalSchema };

package/dist/client/hooks/use-global.d.mts

@@ -0,0 +1,51 @@
+import { RegisteredCMS, RegisteredGlobalNames } from "../builder/registry.mjs";
+import { UseMutationOptions, UseQueryOptions } from "@tanstack/react-query";
+import { Questpie } from "questpie";
+
+//#region src/client/hooks/use-global.d.ts
+type GlobalRealtimeOptions = {
+  realtime?: boolean;
+};
+/**
+ * Resolved global names (string if not registered)
+ */
+type ResolvedGlobalNames = RegisteredCMS extends Questpie<any> ? RegisteredGlobalNames : string;
+/**
+ * Hook to fetch global settings
+ *
+ * Uses RegisteredCMS from module augmentation for automatic type inference.
+ *
+ * @example
+ * ```tsx
+ * // Types inferred from module augmentation!
+ * const { data } = useGlobal("siteSettings");
+ * ```
+ */
+declare function useGlobal<K extends ResolvedGlobalNames>(globalName: K, options?: any, queryOptions?: Omit<UseQueryOptions, "queryKey" | "queryFn">, realtimeOptions?: GlobalRealtimeOptions): any;
+/**
+ * Hook to update global settings
+ *
+ * Uses RegisteredCMS from module augmentation for automatic type inference.
+ *
+ * @example
+ * ```tsx
+ * // Types inferred from module augmentation!
+ * const { mutate } = useGlobalUpdate("siteSettings");
+ * mutate({ data: { siteName: "New Name" } });
+ * ```
+ */
+declare function useGlobalUpdate<K extends ResolvedGlobalNames>(globalName: K, mutationOptions?: Omit<UseMutationOptions, "mutationFn">): any;
+/**
+ * Hook to fetch global version history
+ */
+declare function useGlobalVersions<K extends ResolvedGlobalNames>(globalName: K, options?: {
+  id?: string;
+  limit?: number;
+  offset?: number;
+}, queryOptions?: Omit<UseQueryOptions, "queryKey" | "queryFn">): any;
+/**
+ * Hook to revert global to a previous version
+ */
+declare function useGlobalRevertVersion<K extends ResolvedGlobalNames>(globalName: K, mutationOptions?: Omit<UseMutationOptions, "mutationFn">): any;
+//#endregion
+export { useGlobal, useGlobalRevertVersion, useGlobalUpdate, useGlobalVersions };

package/dist/client/hooks/use-global.mjs

@@ -0,0 +1,284 @@
+import { selectClient, selectContentLocale, useAdminStore } from "../runtime/provider.mjs";
+import { c } from "react/compiler-runtime";
+import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
+import { createQuestpieQueryOptions } from "@questpie/tanstack-query";
+
+//#region src/client/hooks/use-global.ts
+const GLOBAL_QUERY_KEY_PREFIX = ["questpie", "globals"];
+/**
+* Hook to fetch global settings
+*
+* Uses RegisteredCMS from module augmentation for automatic type inference.
+*
+* @example
+* ```tsx
+* // Types inferred from module augmentation!
+* const { data } = useGlobal("siteSettings");
+* ```
+*/
+function useGlobal(globalName, options, queryOptions, realtimeOptions) {
+	const $ = c(12);
+	const client = useAdminStore(selectClient);
+	const contentLocale = useAdminStore(selectContentLocale);
+	const t0 = client;
+	let t1;
+	if ($[0] !== contentLocale || $[1] !== t0) {
+		t1 = createQuestpieQueryOptions(t0, {
+			keyPrefix: GLOBAL_QUERY_KEY_PREFIX,
+			locale: contentLocale
+		});
+		$[0] = contentLocale;
+		$[1] = t0;
+		$[2] = t1;
+	} else t1 = $[2];
+	const queryOpts = t1;
+	let t2;
+	if ($[3] !== contentLocale || $[4] !== globalName || $[5] !== options || $[6] !== queryOpts || $[7] !== realtimeOptions?.realtime) {
+		const globalOptions = {
+			...options,
+			locale: contentLocale
+		};
+		t2 = queryOpts.globals[globalName].get(globalOptions, { realtime: realtimeOptions?.realtime });
+		$[3] = contentLocale;
+		$[4] = globalName;
+		$[5] = options;
+		$[6] = queryOpts;
+		$[7] = realtimeOptions?.realtime;
+		$[8] = t2;
+	} else t2 = $[8];
+	const baseQuery = t2;
+	let t3;
+	if ($[9] !== baseQuery || $[10] !== queryOptions) {
+		t3 = {
+			...baseQuery,
+			...queryOptions
+		};
+		$[9] = baseQuery;
+		$[10] = queryOptions;
+		$[11] = t3;
+	} else t3 = $[11];
+	return useQuery(t3);
+}
+/**
+* Hook to update global settings
+*
+* Uses RegisteredCMS from module augmentation for automatic type inference.
+*
+* @example
+* ```tsx
+* // Types inferred from module augmentation!
+* const { mutate } = useGlobalUpdate("siteSettings");
+* mutate({ data: { siteName: "New Name" } });
+* ```
+*/
+function useGlobalUpdate(globalName, mutationOptions) {
+	const $ = c(20);
+	const client = useAdminStore(selectClient);
+	const contentLocale = useAdminStore(selectContentLocale);
+	const queryClient = useQueryClient();
+	const t0 = client;
+	let t1;
+	if ($[0] !== contentLocale || $[1] !== t0) {
+		t1 = createQuestpieQueryOptions(t0, {
+			keyPrefix: GLOBAL_QUERY_KEY_PREFIX,
+			locale: contentLocale
+		});
+		$[0] = contentLocale;
+		$[1] = t0;
+		$[2] = t1;
+	} else t1 = $[2];
+	const queryOpts = t1;
+	let t2;
+	if ($[3] !== contentLocale || $[4] !== globalName || $[5] !== queryOpts) {
+		t2 = queryOpts.key([
+			"globals",
+			globalName,
+			"get",
+			contentLocale
+		]);
+		$[3] = contentLocale;
+		$[4] = globalName;
+		$[5] = queryOpts;
+		$[6] = t2;
+	} else t2 = $[6];
+	const globalQueryKey = t2;
+	const t3 = queryOpts.globals[globalName];
+	let t4;
+	if ($[7] !== t3) {
+		t4 = t3.update();
+		$[7] = t3;
+		$[8] = t4;
+	} else t4 = $[8];
+	let t5;
+	if ($[9] !== mutationOptions?.onSuccess) {
+		t5 = (data, variables, context) => {
+			(mutationOptions?.onSuccess)?.(data, variables, context);
+		};
+		$[9] = mutationOptions?.onSuccess;
+		$[10] = t5;
+	} else t5 = $[10];
+	let t6;
+	if ($[11] !== globalQueryKey || $[12] !== mutationOptions?.onSettled || $[13] !== queryClient) {
+		t6 = (data_0, error, variables_0, context_0) => {
+			queryClient.invalidateQueries({ queryKey: globalQueryKey });
+			(mutationOptions?.onSettled)?.(data_0, error, variables_0, context_0);
+		};
+		$[11] = globalQueryKey;
+		$[12] = mutationOptions?.onSettled;
+		$[13] = queryClient;
+		$[14] = t6;
+	} else t6 = $[14];
+	let t7;
+	if ($[15] !== mutationOptions || $[16] !== t4 || $[17] !== t5 || $[18] !== t6) {
+		t7 = {
+			...t4,
+			onSuccess: t5,
+			onSettled: t6,
+			...mutationOptions
+		};
+		$[15] = mutationOptions;
+		$[16] = t4;
+		$[17] = t5;
+		$[18] = t6;
+		$[19] = t7;
+	} else t7 = $[19];
+	return useMutation(t7);
+}
+/**
+* Hook to fetch global version history
+*/
+function useGlobalVersions(globalName, options, queryOptions) {
+	const $ = c(10);
+	const client = useAdminStore(selectClient);
+	const contentLocale = useAdminStore(selectContentLocale);
+	const t0 = client;
+	let t1;
+	if ($[0] !== contentLocale || $[1] !== t0) {
+		t1 = createQuestpieQueryOptions(t0, {
+			keyPrefix: GLOBAL_QUERY_KEY_PREFIX,
+			locale: contentLocale
+		});
+		$[0] = contentLocale;
+		$[1] = t0;
+		$[2] = t1;
+	} else t1 = $[2];
+	const t2 = t1.globals[globalName];
+	let t3;
+	if ($[3] !== contentLocale || $[4] !== options || $[5] !== t2) {
+		t3 = t2.findVersions({
+			...options,
+			locale: contentLocale
+		});
+		$[3] = contentLocale;
+		$[4] = options;
+		$[5] = t2;
+		$[6] = t3;
+	} else t3 = $[6];
+	const baseQuery = t3;
+	let t4;
+	if ($[7] !== baseQuery || $[8] !== queryOptions) {
+		t4 = {
+			...baseQuery,
+			...queryOptions
+		};
+		$[7] = baseQuery;
+		$[8] = queryOptions;
+		$[9] = t4;
+	} else t4 = $[9];
+	return useQuery(t4);
+}
+/**
+* Hook to revert global to a previous version
+*/
+function useGlobalRevertVersion(globalName, mutationOptions) {
+	const $ = c(25);
+	const client = useAdminStore(selectClient);
+	const contentLocale = useAdminStore(selectContentLocale);
+	const queryClient = useQueryClient();
+	const t0 = client;
+	let t1;
+	if ($[0] !== contentLocale || $[1] !== t0) {
+		t1 = createQuestpieQueryOptions(t0, {
+			keyPrefix: GLOBAL_QUERY_KEY_PREFIX,
+			locale: contentLocale
+		});
+		$[0] = contentLocale;
+		$[1] = t0;
+		$[2] = t1;
+	} else t1 = $[2];
+	const queryOpts = t1;
+	let t2;
+	if ($[3] !== contentLocale || $[4] !== globalName || $[5] !== queryOpts) {
+		t2 = queryOpts.key([
+			"globals",
+			globalName,
+			"get",
+			contentLocale
+		]);
+		$[3] = contentLocale;
+		$[4] = globalName;
+		$[5] = queryOpts;
+		$[6] = t2;
+	} else t2 = $[6];
+	const globalQueryKey = t2;
+	let t3;
+	if ($[7] !== contentLocale || $[8] !== globalName || $[9] !== queryOpts) {
+		t3 = queryOpts.key([
+			"globals",
+			globalName,
+			"findVersions",
+			contentLocale
+		]);
+		$[7] = contentLocale;
+		$[8] = globalName;
+		$[9] = queryOpts;
+		$[10] = t3;
+	} else t3 = $[10];
+	const versionsQueryKey = t3;
+	const t4 = queryOpts.globals[globalName];
+	let t5;
+	if ($[11] !== t4) {
+		t5 = t4.revertToVersion();
+		$[11] = t4;
+		$[12] = t5;
+	} else t5 = $[12];
+	let t6;
+	if ($[13] !== mutationOptions?.onSuccess) {
+		t6 = (data, variables, context) => {
+			(mutationOptions?.onSuccess)?.(data, variables, context);
+		};
+		$[13] = mutationOptions?.onSuccess;
+		$[14] = t6;
+	} else t6 = $[14];
+	let t7;
+	if ($[15] !== globalQueryKey || $[16] !== mutationOptions?.onSettled || $[17] !== queryClient || $[18] !== versionsQueryKey) {
+		t7 = (data_0, error, variables_0, context_0) => {
+			queryClient.invalidateQueries({ queryKey: globalQueryKey });
+			queryClient.invalidateQueries({ queryKey: versionsQueryKey });
+			(mutationOptions?.onSettled)?.(data_0, error, variables_0, context_0);
+		};
+		$[15] = globalQueryKey;
+		$[16] = mutationOptions?.onSettled;
+		$[17] = queryClient;
+		$[18] = versionsQueryKey;
+		$[19] = t7;
+	} else t7 = $[19];
+	let t8;
+	if ($[20] !== mutationOptions || $[21] !== t5 || $[22] !== t6 || $[23] !== t7) {
+		t8 = {
+			...t5,
+			onSuccess: t6,
+			onSettled: t7,
+			...mutationOptions
+		};
+		$[20] = mutationOptions;
+		$[21] = t5;
+		$[22] = t6;
+		$[23] = t7;
+		$[24] = t8;
+	} else t8 = $[24];
+	return useMutation(t8);
+}
+
+//#endregion
+export { useGlobal, useGlobalRevertVersion, useGlobalUpdate, useGlobalVersions };