@btst/stack 5.0.0 → 5.1.0

package/dist/plugins/cms/query-keys.d.mts

@@ -1,16 +1,16 @@
-import * as _btst_stack_plugins_client from '@btst/stack/plugins/client';
-import { createApiClient } from '@btst/stack/plugins/client';
-import { a as ContentListDiscriminator } from '../../shared/stack.D9x1fR5a.mjs';
+import { a as ContentListDiscriminator } from '../../shared/stack.DFGj0gb7.mjs';
 import { CMSApiRouter } from './api/index.mjs';
-import { S as SerializedContentType, I as InverseRelation, a as SerializedContentItemWithType, P as PaginatedContentItems } from '../../shared/stack.3rxARhgS.mjs';
-import '@btst/stack/plugins/api';
+import { createApiClient, createResourceQueryKeys } from '@btst/stack/plugins/client';
+import { S as SerializedContentType, I as InverseRelation, b as SerializedContentItemWithType } from '../../shared/stack.DrB3L7Ih.mjs';
+import { CMSReadOptions, CMSReadView, PaginatedContentItems, CMSContentFields, CMSContentItemResult } from './api/index.mjs';
 import '../../authorization/index.mjs';
 import 'zod';
+import '@btst/stack/plugins/api';
 import 'better-call';
 import '@tanstack/react-query';
 
 /** Params for the paginated content list (one page per `limit`). */
-interface ContentListParams {
+interface ContentListParams extends CMSReadOptions {
     typeSlug: string;
     limit?: number;
     /**
@@ -22,12 +22,12 @@ interface ContentListParams {
     /** Free-text search across item slugs and data values */
     search?: string;
 }
-interface ContentOptionsParams {
+interface ContentOptionsParams extends CMSReadOptions {
     typeSlug: string;
     search?: string;
     limit?: number;
 }
-interface ContentByRelationParams {
+interface ContentByRelationParams extends CMSReadOptions {
     typeSlug: string;
     field: string;
     targetId: string;
@@ -37,11 +37,13 @@ interface InverseRelationsParams {
     slug: string;
     itemId: string;
 }
-interface InverseRelationItemsParams {
+interface InverseRelationItemsParams extends CMSReadOptions {
     slug: string;
     sourceType: string;
     itemId: string;
     fieldName: string;
+    limit?: number;
+    offset?: number;
 }
 /**
  * CMS resource declaration — the single source of truth for query keys,
@@ -92,8 +94,17 @@ declare const cmsResources: {
                 query: (p: InverseRelationItemsParams) => {
                     itemId: string;
                     fieldName: string;
+                    limit: number;
+                    offset: number;
+                    view: CMSReadView;
+                    fields: string | undefined;
                 };
-                key: (p: InverseRelationItemsParams) => string[];
+                key: (p: InverseRelationItemsParams) => (string | {
+                    fields?: string[] | undefined;
+                    view?: "content" | undefined;
+                    limit: number;
+                    offset: number;
+                })[];
                 select: (data: any) => {
                     items: SerializedContentItemWithType[];
                     total: number;
@@ -111,6 +122,8 @@ declare const cmsResources: {
                 query: (p: ContentListParams) => {
                     limit: number;
                     search: string | undefined;
+                    view: CMSReadView;
+                    fields: string | undefined;
                 };
                 key: (p: ContentListParams) => ContentListDiscriminator[];
                 select: (data: any, _p: ContentListParams) => PaginatedContentItems;
@@ -120,24 +133,36 @@ declare const cmsResources: {
             };
             detail: {
                 path: string;
-                params: (typeSlug: string, id: string) => {
+                params: (typeSlug: string, id: string, _options?: CMSReadOptions) => {
                     typeSlug: string;
                     id: string;
                 };
-                key: (typeSlug: string, id: string) => string[];
-                select: (data: any, _typeSlug: string, _id: string) => SerializedContentItemWithType | null;
+                query: (_typeSlug: string, _id: string, options?: CMSReadOptions) => {
+                    view: CMSReadView;
+                    fields: string | undefined;
+                };
+                key: (typeSlug: string, id: string, options?: CMSReadOptions) => (string | {
+                    fields?: string[] | undefined;
+                    view?: "content" | undefined;
+                })[];
+                select: (data: any, _typeSlug: string, _id: string, _options?: CMSReadOptions) => SerializedContentItemWithType | null;
                 skip: (typeSlug: string, id: string) => boolean;
             };
             bySlug: {
                 path: string;
-                params: (typeSlug: string, _slug: string) => {
+                params: (typeSlug: string, _slug: string, _options?: CMSReadOptions) => {
                     typeSlug: string;
                 };
-                query: (_typeSlug: string, slug: string) => {
+                query: (_typeSlug: string, slug: string, options?: CMSReadOptions) => {
+                    view: CMSReadView;
+                    fields: string | undefined;
                     slug: string;
                     limit: number;
                 };
-                key: (typeSlug: string, slug: string) => string[];
+                key: (typeSlug: string, slug: string, options?: CMSReadOptions) => (string | {
+                    fields?: string[] | undefined;
+                    view?: "content" | undefined;
+                })[];
                 select: (data: any) => SerializedContentItemWithType | null;
                 skip: (typeSlug: string, slug: string) => boolean;
             };
@@ -160,8 +185,15 @@ declare const cmsResources: {
                     field: string;
                     targetId: string;
                     limit: number;
+                    view: CMSReadView;
+                    fields: string | undefined;
                 };
-                key: (p: ContentByRelationParams) => string[];
+                key: (p: ContentByRelationParams) => (string | {
+                    fields?: string[] | undefined;
+                    view?: "content" | undefined;
+                    limit: number;
+                    offset: number;
+                })[];
                 select: (data: any, _p: ContentByRelationParams) => PaginatedContentItems;
                 infinite: true;
                 pageSize: (p: ContentByRelationParams) => number;
@@ -175,8 +207,13 @@ declare const cmsResources: {
                 query: (p: ContentOptionsParams) => {
                     search: string | undefined;
                     limit: number;
+                    view: CMSReadView;
+                    fields: string | undefined;
                 };
-                key: (p: ContentOptionsParams) => (string | number | undefined)[];
+                key: (p: ContentOptionsParams) => (string | number | {
+                    fields?: string[] | undefined;
+                    view?: "content" | undefined;
+                } | undefined)[];
                 select: (data: any, _p: ContentOptionsParams) => SerializedContentItemWithType[];
             };
         };
@@ -247,204 +284,44 @@ declare const cmsResources: {
         };
     };
 };
-/**
- * Create CMS query keys for React Query
- * Used by consumers and SSR loaders to fetch content types and content items
- */
-declare function createCMSQueryKeys(client: ReturnType<typeof createApiClient<CMSApiRouter>>, headers?: HeadersInit): _btst_stack_plugins_client.ResourceQueryKeys<{
-    cmsTypes: {
-        queries: {
-            list: {
-                path: string;
-                key: () => string[];
-                select: (data: any) => (SerializedContentType & {
-                    itemCount: number;
-                })[];
-            };
-            detail: {
-                path: string;
-                params: (slug: string) => {
-                    slug: string;
-                };
-                key: (slug: string) => string[];
-                select: (data: any, _slug: string) => SerializedContentType | null;
-                skip: (slug: string) => boolean;
-            };
-            inverseRelations: {
-                path: string;
-                params: (p: InverseRelationsParams) => {
-                    slug: string;
-                };
-                query: (p: InverseRelationsParams) => {
-                    itemId: string;
-                };
-                key: (p: InverseRelationsParams) => string[];
-                select: (data: any) => InverseRelation[];
-            };
-            inverseRelationItems: {
-                path: string;
-                params: (p: InverseRelationItemsParams) => {
-                    slug: string;
-                    sourceType: string;
-                };
-                query: (p: InverseRelationItemsParams) => {
-                    itemId: string;
-                    fieldName: string;
-                };
-                key: (p: InverseRelationItemsParams) => string[];
-                select: (data: any) => {
-                    items: SerializedContentItemWithType[];
-                    total: number;
-                };
-            };
-        };
+type CMSResourceQueryKeys = ReturnType<typeof createResourceQueryKeys<typeof cmsResources>>;
+type ContentQueryResult<TData> = {
+    queryKey: readonly unknown[];
+    queryFn: (context?: {
+        pageParam?: unknown;
+    }) => Promise<TData>;
+};
+type CMSItemQueryEntry = {
+    <TView extends CMSReadView = undefined, const TFields extends CMSContentFields = undefined>(typeSlug: string, identity: string, options?: CMSReadOptions<TView, TFields>): ContentQueryResult<CMSContentItemResult<Record<string, unknown>, TView, TFields> | null>;
+    _def: readonly [string, string];
+};
+type CMSRelationQueryEntry<TParams> = {
+    <TView extends CMSReadView = undefined, const TFields extends CMSContentFields = undefined>(params: Omit<TParams, "view" | "fields"> & CMSReadOptions<TView, TFields>): ContentQueryResult<PaginatedContentItems<Record<string, unknown>, TView, TFields>>;
+    _def: readonly [string, string];
+};
+type CMSQueryKeys = Omit<CMSResourceQueryKeys, "cmsContent" | "cmsTypes"> & {
+    cmsTypes: Omit<CMSResourceQueryKeys["cmsTypes"], "inverseRelationItems"> & {
+        inverseRelationItems: CMSRelationQueryEntry<InverseRelationItemsParams>;
     };
-    cmsContent: {
-        queries: {
-            list: {
-                path: string;
-                params: (p: ContentListParams) => {
-                    typeSlug: string;
-                };
-                query: (p: ContentListParams) => {
-                    limit: number;
-                    search: string | undefined;
-                };
-                key: (p: ContentListParams) => ContentListDiscriminator[];
-                select: (data: any, _p: ContentListParams) => PaginatedContentItems;
-                infinite: true;
-                pageSize: (p: ContentListParams) => number;
-                nextPageParam: (lastPage: PaginatedContentItems, allPages: PaginatedContentItems[], p: ContentListParams) => number | undefined;
-            };
-            detail: {
-                path: string;
-                params: (typeSlug: string, id: string) => {
-                    typeSlug: string;
-                    id: string;
-                };
-                key: (typeSlug: string, id: string) => string[];
-                select: (data: any, _typeSlug: string, _id: string) => SerializedContentItemWithType | null;
-                skip: (typeSlug: string, id: string) => boolean;
-            };
-            bySlug: {
-                path: string;
-                params: (typeSlug: string, _slug: string) => {
-                    typeSlug: string;
-                };
-                query: (_typeSlug: string, slug: string) => {
-                    slug: string;
-                    limit: number;
-                };
-                key: (typeSlug: string, slug: string) => string[];
-                select: (data: any) => SerializedContentItemWithType | null;
-                skip: (typeSlug: string, slug: string) => boolean;
-            };
-            populated: {
-                path: string;
-                params: (typeSlug: string, id: string) => {
-                    typeSlug: string;
-                    id: string;
-                };
-                key: (typeSlug: string, id: string) => string[];
-                select: (data: any) => SerializedContentItemWithType | null;
-                skip: (typeSlug: string, id: string) => boolean;
-            };
-            byRelation: {
-                path: string;
-                params: (p: ContentByRelationParams) => {
-                    typeSlug: string;
-                };
-                query: (p: ContentByRelationParams) => {
-                    field: string;
-                    targetId: string;
-                    limit: number;
-                };
-                key: (p: ContentByRelationParams) => string[];
-                select: (data: any, _p: ContentByRelationParams) => PaginatedContentItems;
-                infinite: true;
-                pageSize: (p: ContentByRelationParams) => number;
-                nextPageParam: (lastPage: PaginatedContentItems, allPages: PaginatedContentItems[], p: ContentByRelationParams) => number | undefined;
-            };
-            options: {
-                path: string;
-                params: (p: ContentOptionsParams) => {
-                    typeSlug: string;
-                };
-                query: (p: ContentOptionsParams) => {
-                    search: string | undefined;
-                    limit: number;
-                };
-                key: (p: ContentOptionsParams) => (string | number | undefined)[];
-                select: (data: any, _p: ContentOptionsParams) => SerializedContentItemWithType[];
-            };
+    cmsContent: Omit<CMSResourceQueryKeys["cmsContent"], "list" | "detail" | "bySlug" | "byRelation" | "options"> & {
+        list: {
+            <TView extends CMSReadView = undefined, const TFields extends CMSContentFields = undefined>(params: Omit<ContentListParams, "view" | "fields"> & CMSReadOptions<TView, TFields>): ContentQueryResult<PaginatedContentItems<Record<string, unknown>, TView, TFields>>;
+            _def: readonly [string, string];
         };
-        mutations: {
-            create: {
-                path: string;
-                method: "POST";
-                input: (vars: {
-                    typeSlug: string;
-                    slug: string;
-                    data: Record<string, unknown>;
-                }) => {
-                    params: {
-                        typeSlug: string;
-                    };
-                    body: {
-                        slug: string;
-                        data: Record<string, unknown>;
-                    };
-                };
-                select: (data: any) => SerializedContentItemWithType | null;
-                invalidates: string[];
-            };
-            update: {
-                path: string;
-                method: "PUT";
-                input: (vars: {
-                    typeSlug: string;
-                    id: string;
-                    data: {
-                        slug?: string;
-                        data?: Record<string, unknown>;
-                    };
-                }) => {
-                    params: {
-                        typeSlug: string;
-                        id: string;
-                    };
-                    body: {
-                        slug?: string;
-                        data?: Record<string, unknown>;
-                    };
-                };
-                select: (data: any) => SerializedContentItemWithType | null;
-                invalidates: string[];
-                setData: {
-                    query: string;
-                    args: (updated: SerializedContentItemWithType | null) => string[] | null;
-                };
-            };
-            delete: {
-                path: string;
-                method: "DELETE";
-                input: (vars: {
-                    typeSlug: string;
-                    id: string;
-                }) => {
-                    params: {
-                        typeSlug: string;
-                        id: string;
-                    };
-                };
-                select: (data: any) => {
-                    success: boolean;
-                };
-                invalidates: string[];
-            };
+        options: {
+            <TView extends CMSReadView = undefined, const TFields extends CMSContentFields = undefined>(params: Omit<ContentOptionsParams, "view" | "fields"> & CMSReadOptions<TView, TFields>): ContentQueryResult<CMSContentItemResult<Record<string, unknown>, TView, TFields>[]>;
+            _def: readonly [string, string];
         };
+        detail: CMSItemQueryEntry;
+        bySlug: CMSItemQueryEntry;
+        byRelation: CMSRelationQueryEntry<ContentByRelationParams>;
     };
-}>;
+};
+/**
+ * Create CMS query keys for React Query
+ * Used by consumers and SSR loaders to fetch content types and content items
+ */
+declare function createCMSQueryKeys(client: ReturnType<typeof createApiClient<CMSApiRouter>>, headers?: HeadersInit): CMSQueryKeys;
 
 export { cmsResources, createCMSQueryKeys };
 export type { ContentListParams };