@vexcms/core 0.0.19 → 0.1.0-alpha.2

package/dist/api/create/client.d.ts

@@ -0,0 +1,50 @@
+import type { CollectionSlug } from "../../types/generated";
+import type { GenericMutationClientParams } from "../types";
+/**
+ * Client-side args for {@link create}.
+ *
+ * @example
+ * ```tsx
+ * import { create, type CreateClientArgs } from "@vexcms/core/client";
+ * import { useMutation } from "@tanstack/react-query";
+ *
+ * // Inside a React component:
+ * const { mutateAsync } = useMutation({ mutationFn: create() });
+ * await mutateAsync({ collection: "posts", data: { title: "My first post" } });
+ * ```
+ */
+export interface CreateClientArgs extends GenericMutationClientParams {
+    /** The collection slug to insert into. */
+    collection: CollectionSlug;
+    /** Field values for the new document. */
+    data: Record<string, unknown>;
+}
+/**
+ * Returns a `mutationFn` for creating a document in a VexCMS collection.
+ *
+ * Wraps `useConvexMutation(vexConvexApi.create)`. Call at the top level of
+ * a React component (obeys the Rules of Hooks); pass the return value as
+ * `mutationFn` to `useMutation`.
+ *
+ * Import from `@vexcms/core/client`. For the server-side version, import
+ * `create` from `@vexcms/core/server`.
+ *
+ * @returns A mutation function compatible with tanstack-query `useMutation`.
+ * @see {@link CreateClientArgs} for the typed args shape.
+ * @example
+ * ```tsx
+ * import { create } from "@vexcms/core/client";
+ * import { useMutation } from "@tanstack/react-query";
+ *
+ * export function CreatePostButton() {
+ *   const { mutateAsync, isPending } = useMutation({ mutationFn: create() });
+ *   return (
+ *     <button onClick={() => mutateAsync({ collection: "posts", data: { title: "Hi" } })}>
+ *       {isPending ? "Creating…" : "Create"}
+ *     </button>
+ *   );
+ * }
+ * ```
+ */
+export declare function create(): import("convex/react").ReactMutation<import("convex/server").FunctionReference<"mutation", "public", import("../convex").VexCreateArgs, string>>;
+//# sourceMappingURL=client.d.ts.map

package/dist/api/create/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/create/client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,UAAU,CAAC;AAE5D;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,gBAAiB,SAAQ,2BAA2B;IACnE,0CAA0C;IAC1C,UAAU,EAAE,cAAc,CAAC;IAC3B,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,MAAM,qJAErB"}

package/dist/api/create/server.d.ts

@@ -0,0 +1,43 @@
+import type { BetterOmit, DocumentByName, Expand, GenericDataModel, TableNamesInDataModel } from "convex/server";
+import type { CollectionSlug } from "../../types/generated";
+import type { GenericMutationServerParams } from "../types";
+/**
+ * Server-side args for `create`.
+ *
+ * @typeParam DataModel - The Convex data model (inferred from `ctx`).
+ * @typeParam TCollectionSlug - Collection slug.
+ */
+export interface CreateServerArgs<DataModel extends GenericDataModel, TCollectionSlug extends CollectionSlug> extends GenericMutationServerParams<DataModel> {
+    /** The collection slug to insert into. */
+    collection: TCollectionSlug;
+    /**
+     * Field values for the new document. `_id` and `_creationTime` are
+     * excluded — Convex assigns these automatically.
+     *
+     * Passed through `v.any()` at the network boundary; CLI codegen validates
+     * the shape against the Convex schema at build time.
+     */
+    data: Expand<BetterOmit<DocumentByName<DataModel, TableNamesInDataModel<DataModel>>, "_creationTime" | "_id">>;
+}
+/**
+ * Inserts a document into a VexCMS collection and returns its ID.
+ * Server-side only — call inside a Convex mutation handler.
+ *
+ * Import from `@vexcms/core/server`.
+ *
+ * @typeParam DataModel - Convex data model (inferred from `args.ctx`).
+ * @typeParam TCollectionSlug - Collection slug.
+ * @param args - `{ ctx, collection, data }`. `ctx` must be a mutation context.
+ * @returns Promise resolving to the new document's ID as a string.
+ * @example
+ * ```ts
+ * import { create } from "@vexcms/core/server";
+ *
+ * export const createPost = mutation({
+ *   args: { data: v.any() },
+ *   handler: (ctx, args) => create({ ctx, collection: "posts", data: args.data }),
+ * });
+ * ```
+ */
+export declare function create<DataModel extends GenericDataModel, TCollectionSlug extends CollectionSlug>(args: CreateServerArgs<DataModel, TCollectionSlug>): Promise<string>;
+//# sourceMappingURL=server.d.ts.map

package/dist/api/create/server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/api/create/server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,cAAc,EACd,MAAM,EACN,gBAAgB,EAChB,qBAAqB,EACtB,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,UAAU,CAAC;AAI5D;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB,CAC/B,SAAS,SAAS,gBAAgB,EAClC,eAAe,SAAS,cAAc,CACtC,SAAQ,2BAA2B,CAAC,SAAS,CAAC;IAC9C,0CAA0C;IAC1C,UAAU,EAAE,eAAe,CAAC;IAC5B;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CACV,UAAU,CAAC,cAAc,CAAC,SAAS,EAAE,qBAAqB,CAAC,SAAS,CAAC,CAAC,EAAE,eAAe,GAAG,KAAK,CAAC,CACjG,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,MAAM,CAC1B,SAAS,SAAS,gBAAgB,EAClC,eAAe,SAAS,cAAc,EACtC,IAAI,EAAE,gBAAgB,CAAC,SAAS,EAAE,eAAe,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAkCrE"}

package/dist/api/depth.d.ts

@@ -0,0 +1,39 @@
+import type { VexConfig } from "../config";
+import { PopulateShape } from "./types";
+/**
+ * Builds a `PopulateShape`-compatible object covering every relationship field
+ * on `slug`'s collection down to `depth` levels.
+ *
+ * This is the runtime counterpart of the compile-time `DepthPopulate<TCollectionSlug, D>`
+ * type. The returned object can be passed directly to `populateDocs` because it
+ * matches the `PopulateShape` structure:
+ * - Leaf fields (at the requested depth, or targets with no relationships) → `true`
+ * - Intermediate fields → `{ populate: <nested result> }`
+ *
+ * The function relies on the live `VexConfig` available in the `queryApi`
+ * closure. It never touches the database — it only walks the in-memory config.
+ *
+ * **Circular schema guard:** the `visited` set prevents infinite recursion when
+ * two collections point to each other. A circular edge is treated as a leaf
+ * (`true`) — the field is populated one level, but the cycle is cut.
+ *
+ * @param config - The user's resolved `VexConfig`.
+ * @param slug - The collection or global slug to start from.
+ * @param depth - Levels to descend. `0` returns `{}` (no population).
+ * @param visited - Internal cycle guard — callers must not supply this.
+ * @returns A plain object usable as the `populate` arg to `populateDocs`.
+ *
+ * @example depth 1 — all direct relationships populated
+ * ```ts
+ * buildDepthPopulate(config, "posts", 1)
+ * // → { author: true, category: true }
+ * ```
+ * @example depth 2 — relationships of relationships also populated
+ * ```ts
+ * buildDepthPopulate(config, "posts", 2)
+ * // → { author: { populate: { team: true } }, category: true }
+ * //   (category has no relationships → collapses to `true`)
+ * ```
+ */
+export declare function buildDepthPopulate<TPopulate extends PopulateShape = PopulateShape>(config: VexConfig, slug: string, depth: number, visited?: ReadonlySet<string>): TPopulate;
+//# sourceMappingURL=depth.d.ts.map

package/dist/api/depth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"depth.d.ts","sourceRoot":"","sources":["../../src/api/depth.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,SAAS,aAAa,GAAG,aAAa,EAChF,MAAM,EAAE,SAAS,EACjB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,WAAW,CAAC,MAAM,CAAa,GACvC,SAAS,CA8BX"}

package/dist/api/find/client.d.ts

@@ -0,0 +1,90 @@
+import type { FunctionReference } from "convex/server";
+import { type VexFindArgs, type VexFindPaginatedArgs } from "../convex";
+import type { CollectionSlug } from "../../types/generated";
+import type { DocReturnItem, GenericQueryClientParams, PaginationOptions, PaginationResult, PopulateShape, VexQueryOptions } from "../types";
+/**
+ * Client-side args for `find`. Extends {@link GenericQueryClientParams}
+ * to inherit `ctx?: never`, `populate?: TPopulate`, `depth?: D`, and `skip?`.
+ *
+ * @typeParam TCollectionSlug - Collection slug.
+ * @typeParam TPopulate - Populate object, narrowed against `RelationshipKeysOf<TCollectionSlug>`.
+ * @typeParam D - Depth literal (0 = none). Inferred from `depth`.
+ */
+export interface FindClientArgs<TCollectionSlug extends CollectionSlug = CollectionSlug, TPopulate extends PopulateShape<TCollectionSlug> = PopulateShape<TCollectionSlug>, D extends number = number> extends GenericQueryClientParams<TCollectionSlug, TPopulate, D> {
+    collection: TCollectionSlug;
+    limit?: number;
+    paginationOpts?: PaginationOptions;
+}
+/**
+ * Internal Client-side args for `find` with pagination options required. Extends {@link GenericQueryClientParams}
+ * to inherit `ctx?: never`, `populate?: TPopulate`, `depth?: D`, and `skip?`.
+ *
+ * @typeParam TCollectionSlug - Collection slug.
+ * @typeParam TPopulate - Populate object, narrowed against `RelationshipKeysOf<TCollectionSlug>`.
+ * @typeParam D - Depth literal (0 = none). Inferred from `depth`.
+ */
+export interface FindClientPaginatedArgs<TCollectionSlug extends CollectionSlug = CollectionSlug, TPopulate extends PopulateShape<TCollectionSlug> = PopulateShape<TCollectionSlug>, D extends number = number> extends GenericQueryClientParams<TCollectionSlug, TPopulate, D> {
+    collection: TCollectionSlug;
+    limit?: number;
+    paginationOpts: PaginationOptions;
+}
+/**
+ * Returns tanstack-query options for listing documents in a VexCMS collection,
+ * typed to the document of the `collection` slug passed in.
+ *
+ * Client-side only — pass to `useQuery` / `useSuspenseQuery` / `prefetchQuery`.
+ *
+ * Import from `@vexcms/core/client`. For the server-side version, import
+ * `find` from `@vexcms/core/server`.
+ *
+ * Two overloads mirror the server function: without `paginationOpts` the data is
+ * an array; with it, a `PaginationResult`. This keeps callers from having to
+ * narrow a union at every callsite.
+ *
+ * The funcRef is cast per instantiation for the reason documented on `get` —
+ * `api.vex.find` is one registered function serving every collection, so its
+ * return type is fixed at codegen and a runtime `collection` value cannot
+ * narrow it.
+ *
+ * @typeParam TCollectionSlug - Collection slug; compile-error if not registered.
+ * @typeParam TPopulate - Populate object, narrowed against `RelationshipKeysOf<TCollectionSlug>`.
+ * @typeParam D - Depth literal (0 = none). A non-literal `number` degrades to
+ *   `VexDocument`, matching the runtime guard in `DepthPopulated`.
+ * @param args - `{ collection, populate?, depth?, limit?, paginationOpts?, skip? }`.
+ * @returns Tanstack-query options for `useQuery` / `useSuspenseQuery`.
+ * @example
+ * ```tsx
+ * import { find } from "@vexcms/core/client";
+ *
+ * const { data: posts } = useQuery(find({ collection: "posts" }));
+ * //      ^? Post[]
+ *
+ * const { data: page } = useQuery(
+ *   find({ collection: "posts", paginationOpts: { numItems: 20, cursor: null } }),
+ * );
+ * //      ^? PaginationResult<Post>
+ * ```
+ */
+export declare function find<TCollectionSlug extends CollectionSlug, const TPopulate extends PopulateShape<TCollectionSlug> = Record<string, never>, const D extends number = 0>(args: FindClientArgs<TCollectionSlug, TPopulate, D> & {
+    paginationOpts?: never;
+}): VexQueryOptions<VexFindArgs, DocReturnItem<TCollectionSlug, TPopulate, D>[]>;
+export declare function find<TCollectionSlug extends CollectionSlug, const TPopulate extends PopulateShape<TCollectionSlug> = Record<string, never>, const D extends number = 0>(args: FindClientPaginatedArgs<TCollectionSlug, TPopulate, D>): VexQueryOptions<VexFindPaginatedArgs, PaginationResult<DocReturnItem<TCollectionSlug, TPopulate, D>>>;
+export declare namespace find {
+    var queryKey: typeof findQueryKey;
+}
+/**
+ * Returns the tanstack-query queryKey for `find` without issuing a full call.
+ * Use to invalidate the list query after a mutation.
+ *
+ * @typeParam TCollectionSlug - Collection slug.
+ * @typeParam TPopulate - Populate object.
+ * @typeParam D - Depth literal (0 = none).
+ * @param args - The find args to compute the queryKey for.
+ * @returns The tanstack-query `queryKey` array for the given collection.
+ * @example
+ * ```ts
+ * queryClient.invalidateQueries({ queryKey: findQueryKey({ collection: "posts" }) });
+ * ```
+ */
+export declare function findQueryKey<TCollectionSlug extends CollectionSlug, const TPopulate extends PopulateShape<TCollectionSlug> = Record<string, never>, const D extends number = 0>(args: FindClientArgs<TCollectionSlug, TPopulate, D>): ["convexQuery", FunctionReference<"query", "public", VexFindArgs, import("../convex").VexDocument[] | PaginationResult<import("../convex").VexDocument>>, VexFindArgs];
+//# sourceMappingURL=client.d.ts.map

package/dist/api/find/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/find/client.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAEvD,OAAO,EAAgB,KAAK,WAAW,EAAE,KAAK,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACtF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,KAAK,EACV,aAAa,EAGb,wBAAwB,EACxB,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,eAAe,EAChB,MAAM,UAAU,CAAC;AAElB;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc,CAC7B,eAAe,SAAS,cAAc,GAAG,cAAc,EACvD,SAAS,SAAS,aAAa,CAAC,eAAe,CAAC,GAAG,aAAa,CAAC,eAAe,CAAC,EACjF,CAAC,SAAS,MAAM,GAAG,MAAM,CACzB,SAAQ,wBAAwB,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC;IAC/D,UAAU,EAAE,eAAe,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,iBAAiB,CAAC;CACpC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,uBAAuB,CACtC,eAAe,SAAS,cAAc,GAAG,cAAc,EACvD,SAAS,SAAS,aAAa,CAAC,eAAe,CAAC,GAAG,aAAa,CAAC,eAAe,CAAC,EACjF,CAAC,SAAS,MAAM,GAAG,MAAM,CACzB,SAAQ,wBAAwB,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC;IAC/D,UAAU,EAAE,eAAe,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,iBAAiB,CAAC;CACnC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,IAAI,CAClB,eAAe,SAAS,cAAc,EACtC,KAAK,CAAC,SAAS,SAAS,aAAa,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAC9E,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,EAE1B,IAAI,EAAE,cAAc,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC,GAAG;IAAE,cAAc,CAAC,EAAE,KAAK,CAAA;CAAE,GAG/E,eAAe,CAAC,WAAW,EAAE,aAAa,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAChF,wBAAgB,IAAI,CAClB,eAAe,SAAS,cAAc,EACtC,KAAK,CAAC,SAAS,SAAS,aAAa,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAC9E,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,EAE1B,IAAI,EAAE,uBAAuB,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC,GAC3D,eAAe,CAChB,oBAAoB,EACpB,gBAAgB,CAAC,aAAa,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAC/D,CAAC;yBATc,IAAI;;;AAiDpB;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAC1B,eAAe,SAAS,cAAc,EACtC,KAAK,CAAC,SAAS,SAAS,aAAa,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAC9E,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,EAC1B,IAAI,EAAE,cAAc,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC,0KAQpD"}

package/dist/api/find/server.d.ts

@@ -0,0 +1,73 @@
+import type { ExpressionOrValue, FilterBuilder, GenericDataModel, IndexNames, IndexRange, IndexRangeBuilder, NamedIndex, NamedTableInfo, TableNamesInDataModel } from "convex/server";
+import type { CollectionSlug } from "../../types/generated";
+import type { DocReturnItem, GenericQueryServerParams, PaginationOptions, PaginationResult, PopulateShape } from "../types";
+/**
+ * Server-side args for `find`. Extends {@link GenericQueryServerParams}
+ * to inherit `ctx`, `populate`, `depth`, and `config` (with their mutual-exclusion
+ * constraints). All query-chain options map to `ctx.db.query()` equivalents
+ * applied in order: `withIndex` → `order` → `filter` → `take`.
+ *
+ * @typeParam DataModel - The Convex data model (inferred from `ctx`).
+ * @typeParam TCollectionSlug - Collection slug.
+ * @typeParam TPopulate - Populate object.
+ * @typeParam D - Depth literal (0 = no depth, default).
+ */
+export interface FindServerArgs<DataModel extends GenericDataModel, TCollectionSlug extends CollectionSlug, TPopulate extends PopulateShape<TCollectionSlug>, D extends number = 0> extends GenericQueryServerParams<DataModel, TCollectionSlug, TPopulate, D> {
+    /** The collection to query — must match a registered collection slug. */
+    collection: TCollectionSlug;
+    /**
+     * Maximum number of documents to return. Defaults to 100.
+     * Applied as the terminal `.take(n)` on the Convex query.
+     */
+    limit?: number;
+    /**
+     * Result ordering. Equivalent to `.order("asc" | "desc")` on the Convex
+     * query. Defaults to `"asc"` (insertion order).
+     */
+    order?: "asc" | "desc";
+    /**
+     * Filter predicate applied after index narrowing. Equivalent to
+     * `.filter(q => q.eq(q.field("published"), true))` on the Convex query.
+     *
+     * Prefer `withIndex` for performance — `filter` scans every document
+     * in the range and is O(n). Use `filter` for secondary conditions that
+     * can't be expressed as index equality ranges.
+     *
+     * @example
+     * ```ts
+     * find({ ctx, collection: "posts", filter: q => q.eq(q.field("published"), true) })
+     * ```
+     */
+    filter?: (q: FilterBuilder<NamedTableInfo<DataModel, TCollectionSlug extends TableNamesInDataModel<DataModel> ? TCollectionSlug : never>>) => ExpressionOrValue<boolean>;
+    /**
+     * Index to use for the query, with an optional equality/range constraint.
+     * Equivalent to `.withIndex(name, range?)` on the Convex query.
+     *
+     * Using an index is strongly preferred over `filter` for performance.
+     *
+     * @example
+     * ```ts
+     * find({ ctx, collection: "posts", withIndex: { name: "by_slug", range: q => q.eq("slug", "hello") } })
+     * find({ ctx, collection: "posts", withIndex: { name: "by_score", range: q => q.gte("score", 50) } })
+     * find({ ctx, collection: "posts", withIndex: { name: "by_publishedAt" } })
+     * ```
+     */
+    withIndex?: TCollectionSlug extends TableNamesInDataModel<DataModel> ? {
+        name: IndexNames<NamedTableInfo<DataModel, TCollectionSlug>>;
+        range?: (q: IndexRangeBuilder<any, NamedIndex<NamedTableInfo<DataModel, TCollectionSlug>, IndexNames<NamedTableInfo<DataModel, TCollectionSlug>>>>) => IndexRange;
+    } : never;
+    /**
+     * Pagination options. When provided, the function returns a `PaginationResult`
+     * with `{ page, continueCursor, isDone }` instead of a plain array.
+     *
+     * Uses Convex's native `.paginate(opts)` API under the hood.
+     */
+    paginationOpts?: PaginationOptions;
+}
+export declare function find<DataModel extends GenericDataModel, TCollectionSlug extends CollectionSlug, const TPopulate extends PopulateShape<TCollectionSlug> = Record<string, never>, const D extends number = 0>(args: FindServerArgs<DataModel, TCollectionSlug, TPopulate, D> & {
+    paginationOpts?: never;
+}): Promise<DocReturnItem<TCollectionSlug, TPopulate, D>[]>;
+export declare function find<DataModel extends GenericDataModel, TCollectionSlug extends CollectionSlug, const TPopulate extends PopulateShape<TCollectionSlug> = Record<string, never>, const D extends number = 0>(args: FindServerArgs<DataModel, TCollectionSlug, TPopulate, D> & {
+    paginationOpts: PaginationOptions;
+}): Promise<PaginationResult<DocReturnItem<TCollectionSlug, TPopulate, D>>>;
+//# sourceMappingURL=server.d.ts.map

package/dist/api/find/server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/api/find/server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,UAAU,EACV,UAAU,EACV,iBAAiB,EACjB,UAAU,EACV,cAAc,EACd,qBAAqB,EAEtB,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAG5D,OAAO,KAAK,EACV,aAAa,EAGb,wBAAwB,EACxB,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACd,MAAM,UAAU,CAAC;AAalB;;;;;;;;;;GAUG;AACH,MAAM,WAAW,cAAc,CAC7B,SAAS,SAAS,gBAAgB,EAClC,eAAe,SAAS,cAAc,EACtC,SAAS,SAAS,aAAa,CAAC,eAAe,CAAC,EAChD,CAAC,SAAS,MAAM,GAAG,CAAC,CACpB,SAAQ,wBAAwB,CAAC,SAAS,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1E,yEAAyE;IACzE,UAAU,EAAE,eAAe,CAAC;IAE5B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAEvB;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,CACP,CAAC,EAAE,aAAa,CACd,cAAc,CACZ,SAAS,EACT,eAAe,SAAS,qBAAqB,CAAC,SAAS,CAAC,GAAG,eAAe,GAAG,KAAK,CACnF,CACF,KACE,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAEhC;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,EAAE,eAAe,SAAS,qBAAqB,CAAC,SAAS,CAAC,GAChE;QACE,IAAI,EAAE,UAAU,CAAC,cAAc,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC,CAAC;QAC7D,KAAK,CAAC,EAAE,CACN,CAAC,EAAE,iBAAiB,CAElB,GAAG,EACH,UAAU,CACR,cAAc,CAAC,SAAS,EAAE,eAAe,CAAC,EAC1C,UAAU,CAAC,cAAc,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC,CACvD,CACF,KACE,UAAU,CAAC;KACjB,GACD,KAAK,CAAC;IAEV;;;;;OAKG;IACH,cAAc,CAAC,EAAE,iBAAiB,CAAC;CACpC;AAGD,wBAAsB,IAAI,CACxB,SAAS,SAAS,gBAAgB,EAClC,eAAe,SAAS,cAAc,EACtC,KAAK,CAAC,SAAS,SAAS,aAAa,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAC9E,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,EAE1B,IAAI,EAAE,cAAc,CAAC,SAAS,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC,GAAG;IAC/D,cAAc,CAAC,EAAE,KAAK,CAAC;CACxB,GAGA,OAAO,CAAC,aAAa,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAG3D,wBAAsB,IAAI,CACxB,SAAS,SAAS,gBAAgB,EAClC,eAAe,SAAS,cAAc,EACtC,KAAK,CAAC,SAAS,SAAS,aAAa,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAC9E,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,EAE1B,IAAI,EAAE,cAAc,CAAC,SAAS,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC,GAAG;IAC/D,cAAc,EAAE,iBAAiB,CAAC;CACnC,GACA,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC"}

package/dist/api/get/client.d.ts

@@ -0,0 +1,56 @@
+import type { GenericId } from "convex/values";
+import { type VexGetArgs } from "../convex";
+import type { CollectionSlug } from "../../types/generated";
+import type { GenericQueryClientParams, GetReturn, PopulateShape, VexQueryOptions } from "../types";
+/**
+ * Client-side args for `get`. Extends {@link GenericQueryClientParams}
+ * to inherit `ctx?: never`, `populate?: TPopulate`, and `depth?: D`.
+ *
+ * @typeParam TCollectionSlug - Collection slug, recovered from the `Id` brand.
+ * @typeParam TPopulate - Populate object.
+ * @typeParam D - Depth literal (0 = none). Inferred from `depth`.
+ */
+export interface GetClientArgs<TCollectionSlug extends CollectionSlug, TPopulate extends PopulateShape<TCollectionSlug>, D extends number = 0> extends GenericQueryClientParams<TCollectionSlug, TPopulate, D> {
+    id: GenericId<TCollectionSlug>;
+    collection: TCollectionSlug;
+}
+/**
+ * Returns tanstack-query options for fetching a single document by ID, typed to
+ * the document of the `collection` slug passed in.
+ *
+ * Client-side only — pass to `useQuery` / `useSuspenseQuery`.
+ *
+ * Import from `@vexcms/core/client`. For the server-side version, import
+ * `get` from `@vexcms/core/server`.
+ *
+ * ### Why the funcRef is cast
+ *
+ * `api.vex.get` is a single registered Convex function serving every
+ * collection, so codegen fixes one return type for it (`VexDocument | null`) —
+ * `collection` crosses the network boundary as a runtime *value* and can never
+ * narrow it. This wrapper captures the slug as a type (`TCollectionSlug`) at the
+ * call site and casts the reference to {@link GetReturn}, restoring the type the
+ * boundary erased. Sound because the endpoint really does return that
+ * collection's document: the server `get` reads the row from that table.
+ *
+ * @typeParam TCollectionSlug - Collection slug, recovered from the `Id` brand.
+ * @typeParam TPopulate - Populate object.
+ * @typeParam D - Depth literal (0 = none). A non-literal `number` degrades to
+ *   `VexDocument`, matching the runtime guard in `DepthPopulated`.
+ * @param args - `{ id, collection, populate?, depth? }`.
+ * @returns Tanstack-query options whose data is the doc or `null`.
+ * @example
+ * ```tsx
+ * import { get } from "@vexcms/core/client";
+ *
+ * const { data: post } = useQuery(get({ id: postId, collection: "posts" }));
+ * //      ^? Post | null
+ *
+ * const { data: withAuthor } = useQuery(
+ *   get({ id: postId, collection: "posts", populate: { author: true } }),
+ * );
+ * //      ^? (Post & { author: Author[] }) | null
+ * ```
+ */
+export declare function get<TCollectionSlug extends CollectionSlug, const TPopulate extends PopulateShape<TCollectionSlug> = Record<string, never>, const D extends number = 0>(args: GetClientArgs<TCollectionSlug, TPopulate, D>): VexQueryOptions<VexGetArgs, GetReturn<TCollectionSlug, TPopulate, D>>;
+//# sourceMappingURL=client.d.ts.map

package/dist/api/get/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/get/client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE/C,OAAO,EAAgB,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,KAAK,EAAE,wBAAwB,EAAE,SAAS,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAEpG;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa,CAC5B,eAAe,SAAS,cAAc,EACtC,SAAS,SAAS,aAAa,CAAC,eAAe,CAAC,EAChD,CAAC,SAAS,MAAM,GAAG,CAAC,CACpB,SAAQ,wBAAwB,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC;IAC/D,EAAE,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC;IAC/B,UAAU,EAAE,eAAe,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAgB,GAAG,CACjB,eAAe,SAAS,cAAc,EACtC,KAAK,CAAC,SAAS,SAAS,aAAa,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAC9E,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,EAE1B,IAAI,EAAE,aAAa,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC,GACjD,eAAe,CAAC,UAAU,EAAE,SAAS,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAkBvE"}

package/dist/api/get/server.d.ts

@@ -0,0 +1,49 @@
+import type { GenericDataModel } from "convex/server";
+import type { GenericId } from "convex/values";
+import type { CollectionSlug } from "../../types/generated";
+import type { GenericQueryServerParams, GetReturn, PopulateShape } from "../types";
+/**
+ * Server-side args for `get`.
+ *
+ * Inherits `ctx`, `populate`, `depth`, and `config` (with mutual-exclusion
+ * constraints) from {@link GenericQueryServerParams}.
+ *
+ * @typeParam DataModel - The Convex data model (inferred from `ctx`).
+ * @typeParam TCollectionSlug - Collection slug.
+ * @typeParam TPopulate - Populate object.
+ * @typeParam D - Depth literal (0 = no depth, default).
+ */
+export interface GetServerArgs<DataModel extends GenericDataModel, TCollectionSlug extends CollectionSlug, TPopulate extends PopulateShape<TCollectionSlug>, D extends number = 0> extends GenericQueryServerParams<DataModel, TCollectionSlug, TPopulate, D> {
+    /** The document ID to fetch. */
+    id: GenericId<TCollectionSlug>;
+    /** The collection slug to patch this document. */
+    collection: TCollectionSlug;
+}
+/**
+ * Fetches a single document by its `Id<TCollectionSlug>`. Server-side only.
+ *
+ * Pass `populate` to explicitly name the relationship fields to resolve
+ * (documented, recommended). Pass `depth` (with `config`) to automatically
+ * populate all relationship fields to N levels — internal use only.
+ *
+ * Import from `@vexcms/core/server`. For the client-side version, import
+ * `get` from `@vexcms/core/client`.
+ *
+ * @typeParam DataModel - Convex data model (inferred from `args.ctx`).
+ * @typeParam TCollectionSlug - Collection slug, recovered from the `Id` brand.
+ * @typeParam TPopulate - Populate object.
+ * @typeParam D - Depth literal (0 = none).
+ * @param args - `{ ctx, id, populate? }` or `{ ctx, id, depth, config }`.
+ * @returns Promise resolving to the doc or `null` if not found.
+ * @example
+ * ```ts
+ * import { get } from "@vexcms/core/server";
+ *
+ * export const post = query({
+ *   args: { id: v.id("posts") },
+ *   handler: (ctx, args) => get({ ctx, id: args.id, populate: { author: true } }),
+ * });
+ * ```
+ */
+export declare function get<DataModel extends GenericDataModel, TCollectionSlug extends CollectionSlug, const TPopulate extends PopulateShape<TCollectionSlug> = Record<string, never>, const D extends number = 0>(args: GetServerArgs<DataModel, TCollectionSlug, TPopulate, D>): Promise<GetReturn<TCollectionSlug, TPopulate, D>>;
+//# sourceMappingURL=server.d.ts.map

package/dist/api/get/server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/api/get/server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE/C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAG5D,OAAO,KAAK,EAAE,wBAAwB,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAInF;;;;;;;;;;GAUG;AACH,MAAM,WAAW,aAAa,CAC5B,SAAS,SAAS,gBAAgB,EAClC,eAAe,SAAS,cAAc,EACtC,SAAS,SAAS,aAAa,CAAC,eAAe,CAAC,EAChD,CAAC,SAAS,MAAM,GAAG,CAAC,CACpB,SAAQ,wBAAwB,CAAC,SAAS,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1E,gCAAgC;IAChC,EAAE,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC;IAC/B,kDAAkD;IAClD,UAAU,EAAE,eAAe,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,GAAG,CACvB,SAAS,SAAS,gBAAgB,EAClC,eAAe,SAAS,cAAc,EACtC,KAAK,CAAC,SAAS,SAAS,aAAa,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAC9E,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,EAE1B,IAAI,EAAE,aAAa,CAAC,SAAS,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC,GAC5D,OAAO,CAAC,SAAS,CAAC,eAAe,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAoDnD"}

package/dist/api/globals/find.client.d.ts

@@ -0,0 +1,20 @@
+import { type VexGlobalsFindArgs } from "../convex";
+import type { VexDocumentGlobal } from "../../types/generated";
+import type { VexQueryOptions } from "../types";
+/**
+ * Returns tanstack-query options for listing all saved global documents.
+ * Each element is a flat `VexDocumentGlobal` (unnarrowed). For typed
+ * single-global access use `globals.get` instead. Client-side only.
+ *
+ * @returns Tanstack-query `queryOptions` for `useQuery`.
+ *
+ * @example
+ * ```tsx
+ * import { globals } from "@vexcms/core/client";
+ *
+ * const { data } = useQuery(globals.find({}));
+ * data?.map((g) => g._slug); // ["siteSettings", "nav"]
+ * ```
+ */
+export declare function findGlobals(): VexQueryOptions<VexGlobalsFindArgs, VexDocumentGlobal[]>;
+//# sourceMappingURL=find.client.d.ts.map

package/dist/api/globals/find.client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"find.client.d.ts","sourceRoot":"","sources":["../../../src/api/globals/find.client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAgB,KAAK,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAClE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAEhD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,IAAI,eAAe,CAAC,kBAAkB,EAAE,iBAAiB,EAAE,CAAC,CAUtF"}

package/dist/api/globals/find.server.d.ts

@@ -0,0 +1,29 @@
+import type { GenericDataModel } from "convex/server";
+import type { VexDocumentGlobal } from "../../types/generated";
+import type { GenericGlobalsQueryServerArgs } from "./types";
+/**
+ * Returns all rows from `vex_globals` as flat documents, ordered by
+ * `_creationTime` ascending. Only includes globals that have been saved at
+ * least once — globals registered in config but never saved are absent.
+ *
+ * The return type is `VexDocumentGlobal[]` (unnarrowed) because each element
+ * may be a different slug with different user fields. Access specific fields
+ * via the index signature: `doc["siteName"]`. For typed single-global access,
+ * use `getGlobal` instead.
+ *
+ * Server-side only. Import from `@vexcms/core/server`.
+ *
+ * @typeParam DataModel - Convex data model.
+ * @param args - `{ ctx }`.
+ * @returns Flat global documents, unnarrowed.
+ *
+ * @example
+ * ```ts
+ * import { findGlobals } from "@vexcms/core/server";
+ *
+ * const all = await findGlobals({ ctx });
+ * all.map((g) => g._slug); // ["siteSettings", "nav"]
+ * ```
+ */
+export declare function findGlobals<DataModel extends GenericDataModel>(args: GenericGlobalsQueryServerArgs<DataModel>): Promise<VexDocumentGlobal[]>;
+//# sourceMappingURL=find.server.d.ts.map

package/dist/api/globals/find.server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"find.server.d.ts","sourceRoot":"","sources":["../../../src/api/globals/find.server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE/D,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,SAAS,CAAC;AAG7D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,WAAW,CAAC,SAAS,SAAS,gBAAgB,EAClE,IAAI,EAAE,6BAA6B,CAAC,SAAS,CAAC,GAC7C,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAyB9B"}

package/dist/api/globals/get.client.d.ts

@@ -0,0 +1,46 @@
+import { type VexGlobalsGetArgs } from "../convex";
+import type { GlobalSlug, GlobalPopulateShape } from "../../types/generated";
+import type { VexQueryOptions } from "../types";
+import type { GetGlobalReturn } from "./get.server";
+/**
+ * Client-side args for `globals.get`.
+ *
+ * @typeParam TSlug - Global slug; narrowed after `vex generate`.
+ * @typeParam TPopulate - Populate shape; keys restricted to relationship fields.
+ */
+export interface GetGlobalClientArgs<TGlobalSlug extends GlobalSlug = GlobalSlug, TPopulate extends GlobalPopulateShape<TGlobalSlug> = Record<string, never>> {
+    /** Discriminator: client args must NOT include `ctx`. */
+    ctx?: never;
+    /** Global slug to fetch. Compile-error on unknown slugs after `vex generate`. */
+    slug: TGlobalSlug;
+    /** Relationship fields to populate. Keys narrowed to relationship fields post-generate. */
+    populate?: TPopulate;
+}
+/**
+ * Returns tanstack-query options for fetching a single global by slug.
+ * The returned document is flat — user fields are at root level alongside
+ * `_id`, `_creationTime`, and `_slug`. Client-side only.
+ *
+ * Import from `@vexcms/core/client`. For the server-side version, import
+ * `getGlobal` from `@vexcms/core/server`.
+ *
+ * @typeParam TSlug - Global slug.
+ * @typeParam TPopulate - Populate shape.
+ * @param args - `{ slug, populate? }`.
+ * @returns Tanstack-query `queryOptions` for `useQuery`.
+ *
+ * @example
+ * ```tsx
+ * import { globals } from "@vexcms/core/client";
+ *
+ * // Basic
+ * const { data } = useQuery(globals.get({ slug: "siteSettings" }));
+ * data?.siteName; // string | undefined
+ *
+ * // With populate
+ * const { data } = useQuery(globals.get({ slug: "siteSettings", populate: { activeTheme: true } }));
+ * data?.activeTheme; // Doc<"themes">[] (runtime) | Record<string, unknown>[] (type)
+ * ```
+ */
+export declare function getGlobal<TSlug extends GlobalSlug = GlobalSlug, const TPopulate extends GlobalPopulateShape<TSlug> = Record<string, never>>(args: GetGlobalClientArgs<TSlug, TPopulate>): VexQueryOptions<VexGlobalsGetArgs, GetGlobalReturn<TSlug, TPopulate, 0>>;
+//# sourceMappingURL=get.client.d.ts.map

package/dist/api/globals/get.client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get.client.d.ts","sourceRoot":"","sources":["../../../src/api/globals/get.client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAgB,KAAK,iBAAiB,EAAE,MAAM,WAAW,CAAC;AACjE,OAAO,KAAK,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC7E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB,CAClC,WAAW,SAAS,UAAU,GAAG,UAAU,EAC3C,SAAS,SAAS,mBAAmB,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;IAE1E,yDAAyD;IACzD,GAAG,CAAC,EAAE,KAAK,CAAC;IACZ,iFAAiF;IACjF,IAAI,EAAE,WAAW,CAAC;IAClB,2FAA2F;IAC3F,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,SAAS,CACvB,KAAK,SAAS,UAAU,GAAG,UAAU,EACrC,KAAK,CAAC,SAAS,SAAS,mBAAmB,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAE1E,IAAI,EAAE,mBAAmB,CAAC,KAAK,EAAE,SAAS,CAAC,GAC1C,eAAe,CAAC,iBAAiB,EAAE,eAAe,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAe1E"}

package/dist/api/globals/get.server.d.ts

@@ -0,0 +1,55 @@
+import type { GenericDataModel } from "convex/server";
+import type { GlobalSlug, GlobalDocumentBySlug, GlobalPopulateShape, GlobalPopulated, VexDocumentGlobal } from "../../types/generated";
+import type { Prettify } from "../types";
+import { GenericGlobalsQueryServerArgs } from "./types";
+/**
+ * Server-side args for `getGlobal`. Populate and depth are mutually exclusive.
+ *
+ * @typeParam DataModel - Convex data model.
+ * @typeParam TSlug - Global slug.
+ * @typeParam TPopulate - Populate shape.
+ * @typeParam D - Depth literal.
+ */
+export interface GetGlobalServerArgs<DataModel extends GenericDataModel, TGlobalSlug extends GlobalSlug = GlobalSlug, TPopulate extends GlobalPopulateShape<TGlobalSlug> = Record<string, never>, D extends number = 0> extends GenericGlobalsQueryServerArgs<DataModel, TGlobalSlug> {
+    /** Global slug to fetch. Narrowed to `GlobalSlug` after `vex generate`. */
+    slug: TGlobalSlug;
+    /** Relationship fields to populate. Mutually exclusive with `depth`. */
+    populate?: [D] extends [0] ? TPopulate : never;
+    /** Auto-populate all relationship fields to N levels. Mutually exclusive with `populate`. */
+    depth?: [TPopulate] extends [Record<string, never>] ? D : never;
+}
+/**
+ * Return type of `getGlobal` — narrows by populate/depth presence.
+ */
+export type GetGlobalReturn<TSlug extends GlobalSlug, TPopulate extends GlobalPopulateShape<TSlug>, D extends number> = [TPopulate] extends [Record<string, never>] ? [D] extends [0] ? TSlug extends keyof GlobalDocumentBySlug ? GlobalDocumentBySlug[TSlug] | null : VexDocumentGlobal<TSlug> | null : (VexDocumentGlobal<TSlug> & Record<string, unknown>) | null : TSlug extends keyof GlobalDocumentBySlug ? Prettify<GlobalPopulated<TSlug, TPopulate>> | null : never;
+/**
+ * Fetches a single global by slug and returns it as a flat document.
+ * User fields (`siteName`, `activeTheme`, …) are at root level alongside
+ * `_id`, `_creationTime`, and `_slug`. Server-side only.
+ *
+ * Import from `@vexcms/core/server`.
+ *
+ * @typeParam DataModel - Convex data model.
+ * @typeParam TSlug - Global slug.
+ * @typeParam TPopulate - Populate shape.
+ * @typeParam D - Depth literal.
+ * @param args - `{ ctx, slug, populate? }` or `{ ctx, slug, depth, config }`.
+ * @returns Flat global document or `null` if not yet saved.
+ *
+ * @example
+ * ```ts
+ * import { getGlobal } from "@vexcms/core/server";
+ *
+ * const settings = await getGlobal({ ctx, slug: "siteSettings" });
+ * settings?.siteName; // string | undefined
+ *
+ * const populated = await getGlobal({
+ *   ctx,
+ *   slug: "siteSettings",
+ *   populate: { activeTheme: true },
+ * });
+ * populated?.activeTheme; // Doc<"themes">[] | undefined (runtime correct, type widened)
+ * ```
+ */
+export declare function getGlobal<DataModel extends GenericDataModel, TGlobalSlug extends GlobalSlug = GlobalSlug, TPopulate extends GlobalPopulateShape<TGlobalSlug> = Record<string, never>, D extends number = 0>(args: GetGlobalServerArgs<DataModel, TGlobalSlug, TPopulate, D>): Promise<GetGlobalReturn<TGlobalSlug, TPopulate, D>>;
+//# sourceMappingURL=get.server.d.ts.map

package/dist/api/globals/get.server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get.server.d.ts","sourceRoot":"","sources":["../../../src/api/globals/get.server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEtD,OAAO,KAAK,EACV,UAAU,EACV,oBAAoB,EACpB,mBAAmB,EACnB,eAAe,EACf,iBAAiB,EAClB,MAAM,uBAAuB,CAAC;AAG/B,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,6BAA6B,EAAE,MAAM,SAAS,CAAC;AAmBxD;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAmB,CAClC,SAAS,SAAS,gBAAgB,EAClC,WAAW,SAAS,UAAU,GAAG,UAAU,EAC3C,SAAS,SAAS,mBAAmB,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAC1E,CAAC,SAAS,MAAM,GAAG,CAAC,CACpB,SAAQ,6BAA6B,CAAC,SAAS,EAAE,WAAW,CAAC;IAC7D,2EAA2E;IAC3E,IAAI,EAAE,WAAW,CAAC;IAClB,wEAAwE;IACxE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,KAAK,CAAC;IAC/C,6FAA6F;IAC7F,KAAK,CAAC,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;CACjE;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,CACzB,KAAK,SAAS,UAAU,EACxB,SAAS,SAAS,mBAAmB,CAAC,KAAK,CAAC,EAC5C,CAAC,SAAS,MAAM,IACd,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,GAC3C,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GACb,KAAK,SAAS,MAAM,oBAAoB,GACtC,oBAAoB,CAAC,KAAK,CAAC,GAAG,IAAI,GAClC,iBAAiB,CAAC,KAAK,CAAC,GAAG,IAAI,GACjC,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,IAAI,GAC7D,KAAK,SAAS,MAAM,oBAAoB,GACtC,QAAQ,CAAC,eAAe,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,GAAG,IAAI,GAClD,KAAK,CAAC;AAEZ;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,SAAS,CAC7B,SAAS,SAAS,gBAAgB,EAClC,WAAW,SAAS,UAAU,GAAG,UAAU,EAC3C,SAAS,SAAS,mBAAmB,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAC1E,CAAC,SAAS,MAAM,GAAG,CAAC,EAEpB,IAAI,EAAE,mBAAmB,CAAC,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC,GAC9D,OAAO,CAAC,eAAe,CAAC,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAiDrD"}