@proofkit/fmodata 0.1.0-alpha.4 → 0.1.0-alpha.7

package/dist/esm/client/query-builder.d.ts

@@ -1,22 +1,28 @@
 import { QueryOptions } from 'odata-query';
-import { ExecutionContext, WithSystemFields, Result, InferSchemaType, ExecuteOptions, ConditionallyWithODataAnnotations, ExtractSchemaFromOccurrence } from '../types.js';
+import { ExecutionContext, ExecutableBuilder, WithSystemFields, Result, InferSchemaType, ExecuteOptions, ConditionallyWithODataAnnotations, ExtractSchemaFromOccurrence } from '../types.js';
 import { Filter } from '../filter-types.js';
 import { TableOccurrence } from './table-occurrence.js';
 import { BaseTable } from './base-table.js';
 import { FFetchOptions } from '@fetchkit/ffetch';
-import { z } from 'zod/v4';
 import { StandardSchemaV1 } from '@standard-schema/spec';
 type ExtractNavigationNames<O extends TableOccurrence<any, any, any, any> | undefined> = O extends TableOccurrence<any, any, infer Nav, any> ? Nav extends Record<string, any> ? keyof Nav & string : never : never;
 type ResolveNavigationItem<T> = T extends () => infer R ? R : T;
-type FindNavigationTarget<O extends TableOccurrence<any, any, any, any> | undefined, Name extends string> = O extends TableOccurrence<any, any, infer Nav, any> ? Nav extends Record<string, any> ? Name extends keyof Nav ? ResolveNavigationItem<Nav[Name]> : TableOccurrence<BaseTable<Record<string, z.ZodTypeAny>, any>, any, any, any> : TableOccurrence<BaseTable<Record<string, z.ZodTypeAny>, any>, any, any, any> : TableOccurrence<BaseTable<Record<string, z.ZodTypeAny>, any>, any, any, any>;
+type FindNavigationTarget<O extends TableOccurrence<any, any, any, any> | undefined, Name extends string> = O extends TableOccurrence<any, any, infer Nav, any> ? Nav extends Record<string, any> ? Name extends keyof Nav ? ResolveNavigationItem<Nav[Name]> : TableOccurrence<BaseTable<Record<string, StandardSchemaV1>, any, any, any>, any, any, any> : TableOccurrence<BaseTable<Record<string, StandardSchemaV1>, any, any, any>, any, any, any> : TableOccurrence<BaseTable<Record<string, StandardSchemaV1>, any, any, any>, any, any, any>;
 type GetTargetSchemaType<O extends TableOccurrence<any, any, any, any> | undefined, Rel extends string> = [FindNavigationTarget<O, Rel>] extends [
     TableOccurrence<infer BT, any, any, any>
 ] ? [BT] extends [BaseTable<infer S, any>] ? [S] extends [Record<string, StandardSchemaV1>] ? InferSchemaType<S> : Record<string, any> : Record<string, any> : Record<string, any>;
-type ExpandedRelations = Record<string, {
+export type ExpandedRelations = Record<string, {
     schema: any;
     selected: any;
 }>;
-export declare class QueryBuilder<T extends Record<string, any>, Selected extends keyof T = keyof T, SingleMode extends "exact" | "maybe" | false = false, IsCount extends boolean = false, Occ extends TableOccurrence<any, any, any, any> | undefined = undefined, Expands extends ExpandedRelations = {}> {
+export type QueryReturnType<T extends Record<string, any>, Selected extends keyof T, SingleMode extends "exact" | "maybe" | false, IsCount extends boolean, Expands extends ExpandedRelations> = IsCount extends true ? number : SingleMode extends "exact" ? Pick<T, Selected> & {
+    [K in keyof Expands]: Pick<Expands[K]["schema"], Expands[K]["selected"]>[];
+} : SingleMode extends "maybe" ? (Pick<T, Selected> & {
+    [K in keyof Expands]: Pick<Expands[K]["schema"], Expands[K]["selected"]>[];
+}) | null : (Pick<T, Selected> & {
+    [K in keyof Expands]: Pick<Expands[K]["schema"], Expands[K]["selected"]>[];
+})[];
+export declare class QueryBuilder<T extends Record<string, any>, Selected extends keyof T = keyof T, SingleMode extends "exact" | "maybe" | false = false, IsCount extends boolean = false, Occ extends TableOccurrence<any, any, any, any> | undefined = undefined, Expands extends ExpandedRelations = {}> implements ExecutableBuilder<QueryReturnType<T, Selected, SingleMode, IsCount, Expands>> {
     private queryOptions;
     private expandConfigs;
     private singleMode;
@@ -30,16 +36,27 @@ export declare class QueryBuilder<T extends Record<string, any>, Selected extend
     private navigateRelation?;
     private navigateSourceTableName?;
     private navigateBaseRelation?;
+    private databaseUseEntityIds;
     constructor(config: {
         occurrence?: Occ;
         tableName: string;
         databaseName: string;
         context: ExecutionContext;
+        databaseUseEntityIds?: boolean;
     });
+    /**
+     * Helper to merge database-level useEntityIds with per-request options
+     */
+    private mergeExecuteOptions;
     /**
      * Helper to conditionally strip OData annotations based on options
      */
     private stripODataAnnotationsIfNeeded;
+    /**
+     * Gets the table ID (FMTID) if using entity IDs, otherwise returns the table name
+     * @param useEntityIds - Optional override for entity ID usage
+     */
+    private getTableId;
     select<K extends keyof T>(...fields: K[]): QueryBuilder<T, K, SingleMode, IsCount, Occ, Expands>;
     /**
      * Transforms our filter format to odata-query's expected format
@@ -54,6 +71,7 @@ export declare class QueryBuilder<T extends Record<string, any>, Selected extend
     skip(count: number): QueryBuilder<T, Selected, SingleMode, IsCount, Occ, Expands>;
     /**
      * Formats select fields for use in query strings.
+     * - Transforms field names to FMFIDs if using entity IDs
      * - Wraps "id" fields in double quotes
      * - URL-encodes special characters but preserves spaces
      */
@@ -66,6 +84,7 @@ export declare class QueryBuilder<T extends Record<string, any>, Selected extend
     /**
      * Builds OData expand query string from expand configurations.
      * Handles nested expands recursively.
+     * Transforms relation names to FMTIDs if using entity IDs.
      */
     private buildExpandString;
     expand<Rel extends ExtractNavigationNames<Occ> | (string & {}), TargetOcc extends FindNavigationTarget<Occ, Rel> = FindNavigationTarget<Occ, Rel>, TargetSchema extends GetTargetSchemaType<Occ, Rel> = GetTargetSchemaType<Occ, Rel>, TargetSelected extends keyof TargetSchema = keyof TargetSchema>(relation: Rel, callback?: (builder: QueryBuilder<TargetSchema, keyof TargetSchema, false, false, TargetOcc extends TableOccurrence<any, any, any, any> ? TargetOcc : undefined>) => QueryBuilder<WithSystemFields<TargetSchema>, TargetSelected, any, any, any>): QueryBuilder<T, Selected, SingleMode, IsCount, Occ, Expands & {
@@ -90,5 +109,7 @@ export declare class QueryBuilder<T extends Record<string, any>, Selected extend
         url: string;
         body?: any;
     };
+    toRequest(baseUrl: string): Request;
+    processResponse(response: Response, options?: ExecuteOptions): Promise<Result<QueryReturnType<T, Selected, SingleMode, IsCount, Expands>>>;
 }
 export {};