@proofkit/fmodata 0.1.0-alpha.8 → 0.1.0-beta.23

package/dist/esm/types.d.ts

@@ -1,5 +1,6 @@
 import { FFetchOptions } from '@fetchkit/ffetch';
 import { StandardSchemaV1 } from '@standard-schema/spec';
+import { InternalLogger } from './logger.js';
 export type Auth = {
     username: string;
     password: string;
@@ -16,9 +17,10 @@ export interface ExecutableBuilder<T> {
     /**
      * Convert this builder to a native Request object for batch processing.
      * @param baseUrl - The base URL for the OData service
+     * @param options - Optional execution options (e.g., includeODataAnnotations)
      * @returns A native Request object
      */
-    toRequest(baseUrl: string): Request;
+    toRequest(baseUrl: string, options?: ExecuteOptions): Request;
     /**
      * Process a raw Response object into a typed Result.
      * This allows builders to apply their own validation and transformation logic.
@@ -31,35 +33,38 @@ export interface ExecutableBuilder<T> {
 export interface ExecutionContext {
     _makeRequest<T>(url: string, options?: RequestInit & FFetchOptions & {
         useEntityIds?: boolean;
+        includeSpecialColumns?: boolean;
     }): Promise<Result<T>>;
     _setUseEntityIds?(useEntityIds: boolean): void;
     _getUseEntityIds?(): boolean;
+    _setIncludeSpecialColumns?(includeSpecialColumns: boolean): void;
+    _getIncludeSpecialColumns?(): boolean;
     _getBaseUrl?(): string;
+    _getLogger?(): InternalLogger;
 }
 export type InferSchemaType<Schema extends Record<string, StandardSchemaV1>> = {
     [K in keyof Schema]: Schema[K] extends StandardSchemaV1<any, infer Output> ? Output : never;
 };
-export type WithSystemFields<T> = T extends Record<string, any> ? T & {
+export type WithSpecialColumns<T> = T extends Record<string, any> ? T & {
     ROWID: number;
     ROWMODID: number;
 } : never;
 export type ExcludeSystemFields<T extends keyof any> = Exclude<T, "ROWID" | "ROWMODID">;
-export type OmitSystemFields<T> = Omit<T, "ROWID" | "ROWMODID">;
-export type ODataRecordMetadata = {
+export interface ODataRecordMetadata {
     "@id": string;
     "@editLink": string;
-};
-export type ODataListResponse<T> = {
+}
+export interface ODataListResponse<T> {
     "@context": string;
     value: (T & ODataRecordMetadata)[];
-};
+}
 export type ODataSingleResponse<T> = T & ODataRecordMetadata & {
     "@context": string;
 };
-export type ODataFieldResponse<T> = {
+export interface ODataFieldResponse<T> {
     "@context": string;
     value: T;
-};
+}
 export type Result<T, E = import('./errors.js').FMODataErrorType> = {
     data: T;
     error: undefined;
@@ -67,48 +72,110 @@ export type Result<T, E = import('./errors.js').FMODataErrorType> = {
     data: undefined;
     error: E;
 };
+export interface BatchItemResult<T> {
+    data: T | undefined;
+    error: import('./errors.js').FMODataErrorType | undefined;
+    status: number;
+}
+export interface BatchResult<T extends readonly any[]> {
+    results: {
+        [K in keyof T]: BatchItemResult<T[K]>;
+    };
+    successCount: number;
+    errorCount: number;
+    truncated: boolean;
+    firstErrorIndex: number | null;
+}
 export type MakeFieldsRequired<T, Keys extends keyof T> = Partial<T> & Required<Pick<T, Keys>>;
 export type AutoRequiredKeys<Schema extends Record<string, StandardSchemaV1>> = {
     [K in keyof Schema]: Extract<StandardSchemaV1.InferOutput<Schema[K]>, null | undefined> extends never ? K : never;
 }[keyof Schema];
 export type ExcludedFields<IdField extends keyof any | undefined, ReadOnly extends readonly any[]> = IdField extends keyof any ? IdField | ReadOnly[number] : ReadOnly[number];
-type ComputeInsertData<Schema extends Record<string, StandardSchemaV1>, IdField extends keyof Schema | undefined, Required extends readonly any[], ReadOnly extends readonly any[]> = [Required[number]] extends [keyof InferSchemaType<Schema>] ? Required extends readonly (keyof InferSchemaType<Schema>)[] ? MakeFieldsRequired<Omit<InferSchemaType<Schema>, ExcludedFields<IdField, ReadOnly>>, Exclude<AutoRequiredKeys<Schema> | Required[number], ExcludedFields<IdField, ReadOnly>>> : MakeFieldsRequired<Omit<InferSchemaType<Schema>, ExcludedFields<IdField, ReadOnly>>, Exclude<AutoRequiredKeys<Schema>, ExcludedFields<IdField, ReadOnly>>> : MakeFieldsRequired<Omit<InferSchemaType<Schema>, ExcludedFields<IdField, ReadOnly>>, Exclude<AutoRequiredKeys<Schema>, ExcludedFields<IdField, ReadOnly>>>;
-export type InsertData<BT> = BT extends import('./client/base-table.js').BaseTable<any, any, any, any> ? BT extends {
-    schema: infer Schema;
-    idField?: infer IdField;
-    required?: infer Required;
-    readOnly?: infer ReadOnly;
-} ? Schema extends Record<string, StandardSchemaV1> ? IdField extends keyof Schema | undefined ? Required extends readonly any[] ? ReadOnly extends readonly any[] ? ComputeInsertData<Schema, Extract<IdField, keyof Schema | undefined>, Required, ReadOnly> : Partial<Record<string, any>> : Partial<Record<string, any>> : Partial<Record<string, any>> : Partial<Record<string, any>> : Partial<Record<string, any>> : Partial<Record<string, any>>;
-export type UpdateData<BT> = BT extends import('./client/base-table.js').BaseTable<any, any, any, any> ? BT extends {
-    schema: infer Schema;
-    idField?: infer IdField;
-    readOnly?: infer ReadOnly;
-} ? Schema extends Record<string, StandardSchemaV1> ? IdField extends keyof Schema | undefined ? ReadOnly extends readonly any[] ? Partial<Omit<InferSchemaType<Schema>, ExcludedFields<Extract<IdField, keyof Schema | undefined>, ReadOnly>>> : Partial<Record<string, any>> : Partial<Record<string, any>> : Partial<Record<string, any>> : Partial<Record<string, any>> : Partial<Record<string, any>>;
-export type ExecuteOptions = {
+export interface ExecuteOptions {
     includeODataAnnotations?: boolean;
     skipValidation?: boolean;
     /**
      * Overrides the default behavior of the database to use entity IDs (rather than field names) in THIS REQUEST ONLY
      */
     useEntityIds?: boolean;
-};
+    /**
+     * Overrides the default behavior of the database to include special columns (ROWID and ROWMODID) in THIS REQUEST ONLY.
+     * Note: Special columns are only included when there is no $select query.
+     */
+    includeSpecialColumns?: boolean;
+}
+/**
+ * Type for the fetchHandler callback function.
+ * This is a convenience type export that matches the fetchHandler signature in FFetchOptions.
+ *
+ * @example
+ * ```typescript
+ * import type { FetchHandler } from '@proofkit/fmodata';
+ *
+ * const myFetchHandler: FetchHandler = (input, init) => {
+ *   console.log('Custom fetch:', input);
+ *   return fetch(input, init);
+ * };
+ *
+ * await query.execute({
+ *   fetchHandler: myFetchHandler
+ * });
+ * ```
+ */
+export type FetchHandler = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
+/**
+ * Combined type for execute() method options.
+ *
+ * Uses FFetchOptions from @fetchkit/ffetch to ensure proper type inference.
+ * FFetchOptions is re-exported in the package to ensure type availability in consuming packages.
+ */
+export type ExecuteMethodOptions<EO extends ExecuteOptions = ExecuteOptions> = RequestInit & FFetchOptions & ExecuteOptions & EO;
+/**
+ * Get the Accept header value based on includeODataAnnotations option
+ * @param includeODataAnnotations - Whether to include OData annotations
+ * @returns Accept header value
+ */
+export declare function getAcceptHeader(includeODataAnnotations?: boolean): string;
 export type ConditionallyWithODataAnnotations<T, IncludeODataAnnotations extends boolean> = IncludeODataAnnotations extends true ? T & {
     "@id": string;
     "@editLink": string;
 } : T;
+/**
+ * Normalizes includeSpecialColumns with a database-level default.
+ * Uses distributive conditional types to handle unions correctly.
+ * @template IncludeSpecialColumns - The includeSpecialColumns value from execute options
+ * @template DatabaseDefault - The database-level includeSpecialColumns setting (defaults to false)
+ */
+export type NormalizeIncludeSpecialColumns<IncludeSpecialColumns extends boolean | undefined, DatabaseDefault extends boolean = false> = [IncludeSpecialColumns] extends [true] ? true : [IncludeSpecialColumns] extends [false] ? false : DatabaseDefault;
+/**
+ * Conditionally adds ROWID and ROWMODID special columns to a type.
+ * Special columns are only included when:
+ * - includeSpecialColumns is true AND
+ * - hasSelect is false (no $select query was applied) AND
+ * - T is an object type (not a primitive like string or number)
+ *
+ * Handles both single objects and arrays of objects.
+ */
+export type ConditionallyWithSpecialColumns<T, IncludeSpecialColumns extends boolean, HasSelect extends boolean> = IncludeSpecialColumns extends true ? HasSelect extends false ? T extends readonly (infer U)[] ? U extends Record<string, any> ? (U & {
+    ROWID: number;
+    ROWMODID: number;
+})[] : T : T extends Record<string, any> ? T & {
+    ROWID: number;
+    ROWMODID: number;
+} : T : T : T;
 export type ExtractSchemaFromOccurrence<Occ> = Occ extends {
     baseTable: {
         schema: infer S;
     };
 } ? S extends Record<string, StandardSchemaV1> ? S : Record<string, StandardSchemaV1> : Record<string, StandardSchemaV1>;
-export type GenericFieldMetadata = {
+export interface GenericFieldMetadata {
     $Nullable?: boolean;
     "@Index"?: boolean;
     "@Calculation"?: boolean;
     "@Summary"?: boolean;
     "@Global"?: boolean;
     "@Org.OData.Core.V1.Permissions"?: "Org.OData.Core.V1.Permission@Read";
-};
+}
 export type StringFieldMetadata = GenericFieldMetadata & {
     $Type: "Edm.String";
     $DefaultValue?: "USER" | "USERNAME" | "CURRENT_USER";
@@ -131,21 +198,20 @@ export type DateTimeOffsetFieldMetadata = GenericFieldMetadata & {
     $DefaultValue?: "CURTIMESTAMP" | "CURRENT_TIMESTAMP";
     "@VersionId"?: boolean;
 };
-export type StreamFieldMetadata = {
+export interface StreamFieldMetadata {
     $Type: "Edm.Stream";
     $Nullable?: boolean;
     "@EnclosedPath": string;
     "@ExternalOpenPath": string;
     "@ExternalSecurePath"?: string;
-};
+}
 export type FieldMetadata = StringFieldMetadata | DecimalFieldMetadata | DateFieldMetadata | TimeOfDayFieldMetadata | DateTimeOffsetFieldMetadata | StreamFieldMetadata;
 export type EntityType = {
     $Kind: "EntityType";
     $Key: string[];
 } & Record<string, FieldMetadata>;
-export type EntitySet = {
+export interface EntitySet {
     $Kind: "EntitySet";
     $Type: string;
-};
+}
 export type Metadata = Record<string, EntityType | EntitySet>;
-export {};

package/dist/esm/types.js

@@ -0,0 +1,7 @@
+function getAcceptHeader(includeODataAnnotations) {
+  return includeODataAnnotations === true ? "application/json" : "application/json;odata.metadata=none";
+}
+export {
+  getAcceptHeader
+};
+//# sourceMappingURL=types.js.map

package/dist/esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sources":["../../src/types.ts"],"sourcesContent":["import type { FFetchOptions } from \"@fetchkit/ffetch\";\nimport type { StandardSchemaV1 } from \"@standard-schema/spec\";\nimport type { InternalLogger } from \"./logger\";\n\nexport type Auth = { username: string; password: string } | { apiKey: string };\n\nexport interface ExecutableBuilder<T> {\n  execute(): Promise<Result<T>>;\n  // biome-ignore lint/suspicious/noExplicitAny: Request body can be any JSON-serializable value\n  getRequestConfig(): { method: string; url: string; body?: any };\n\n  /**\n   * Convert this builder to a native Request object for batch processing.\n   * @param baseUrl - The base URL for the OData service\n   * @param options - Optional execution options (e.g., includeODataAnnotations)\n   * @returns A native Request object\n   */\n  toRequest(baseUrl: string, options?: ExecuteOptions): Request;\n\n  /**\n   * Process a raw Response object into a typed Result.\n   * This allows builders to apply their own validation and transformation logic.\n   * @param response - The native Response object from the batch operation\n   * @param options - Optional execution options (e.g., skipValidation, includeODataAnnotations)\n   * @returns A typed Result with the builder's expected return type\n   */\n  processResponse(response: Response, options?: ExecuteOptions): Promise<Result<T>>;\n}\n\nexport interface ExecutionContext {\n  _makeRequest<T>(\n    url: string,\n    options?: RequestInit &\n      FFetchOptions & {\n        useEntityIds?: boolean;\n        includeSpecialColumns?: boolean;\n      },\n  ): Promise<Result<T>>;\n  _setUseEntityIds?(useEntityIds: boolean): void;\n  _getUseEntityIds?(): boolean;\n  _setIncludeSpecialColumns?(includeSpecialColumns: boolean): void;\n  _getIncludeSpecialColumns?(): boolean;\n  _getBaseUrl?(): string;\n  _getLogger?(): InternalLogger;\n}\n\nexport type InferSchemaType<Schema extends Record<string, StandardSchemaV1>> = {\n  // biome-ignore lint/suspicious/noExplicitAny: Required for type inference with infer\n  [K in keyof Schema]: Schema[K] extends StandardSchemaV1<any, infer Output> ? Output : never;\n};\n\nexport type WithSpecialColumns<T> =\n  // biome-ignore lint/suspicious/noExplicitAny: Generic constraint accepting any record shape\n  T extends Record<string, any>\n    ? T & {\n        ROWID: number;\n        ROWMODID: number;\n      }\n    : never;\n\n// Helper type to exclude special columns from a union of keys\n// biome-ignore lint/suspicious/noExplicitAny: Generic constraint accepting any key type\nexport type ExcludeSystemFields<T extends keyof any> = Exclude<T, \"ROWID\" | \"ROWMODID\">;\n\n// OData record metadata fields (present on each record)\nexport interface ODataRecordMetadata {\n  \"@id\": string;\n  \"@editLink\": string;\n}\n\n// OData response wrapper (top-level, internal use only)\nexport interface ODataListResponse<T> {\n  \"@context\": string;\n  value: (T & ODataRecordMetadata)[];\n}\n\nexport type ODataSingleResponse<T> = T &\n  ODataRecordMetadata & {\n    \"@context\": string;\n  };\n\n// OData response for single field values\nexport interface ODataFieldResponse<T> {\n  \"@context\": string;\n  value: T;\n}\n\n// Result pattern for execute responses\nexport type Result<T, E = import(\"./errors\").FMODataErrorType> =\n  | { data: T; error: undefined }\n  | { data: undefined; error: E };\n\n// Batch operation result types\nexport interface BatchItemResult<T> {\n  data: T | undefined;\n  error: import(\"./errors\").FMODataErrorType | undefined;\n  status: number; // HTTP status code (0 for truncated)\n}\n\n// biome-ignore lint/suspicious/noExplicitAny: Generic constraint accepting any tuple type\nexport interface BatchResult<T extends readonly any[]> {\n  results: { [K in keyof T]: BatchItemResult<T[K]> };\n  successCount: number;\n  errorCount: number;\n  truncated: boolean;\n  firstErrorIndex: number | null;\n}\n\n// Make specific keys required, rest optional\nexport type MakeFieldsRequired<T, Keys extends keyof T> = Partial<T> & Required<Pick<T, Keys>>;\n\n// Extract keys from schema where validator doesn't allow null/undefined (auto-required fields)\nexport type AutoRequiredKeys<Schema extends Record<string, StandardSchemaV1>> = {\n  [K in keyof Schema]: Extract<StandardSchemaV1.InferOutput<Schema[K]>, null | undefined> extends never ? K : never;\n}[keyof Schema];\n\n// Helper type to compute excluded fields (readOnly fields + idField)\nexport type ExcludedFields<\n  // biome-ignore lint/suspicious/noExplicitAny: Generic constraint accepting any key type\n  IdField extends keyof any | undefined,\n  // biome-ignore lint/suspicious/noExplicitAny: Generic constraint accepting any array type\n  ReadOnly extends readonly any[],\n  // biome-ignore lint/suspicious/noExplicitAny: Generic constraint accepting any key type\n> = IdField extends keyof any ? IdField | ReadOnly[number] : ReadOnly[number];\n\n// Helper type for InsertData computation\ntype _ComputeInsertData<\n  Schema extends Record<string, StandardSchemaV1>,\n  IdField extends keyof Schema | undefined,\n  // biome-ignore lint/suspicious/noExplicitAny: Generic constraint accepting any array type\n  Required extends readonly any[],\n  // biome-ignore lint/suspicious/noExplicitAny: Generic constraint accepting any array type\n  ReadOnly extends readonly any[],\n> = [Required[number]] extends [keyof InferSchemaType<Schema>]\n  ? Required extends readonly (keyof InferSchemaType<Schema>)[]\n    ? MakeFieldsRequired<\n        Omit<InferSchemaType<Schema>, ExcludedFields<IdField, ReadOnly>>,\n        Exclude<AutoRequiredKeys<Schema> | Required[number], ExcludedFields<IdField, ReadOnly>>\n      >\n    : MakeFieldsRequired<\n        Omit<InferSchemaType<Schema>, ExcludedFields<IdField, ReadOnly>>,\n        Exclude<AutoRequiredKeys<Schema>, ExcludedFields<IdField, ReadOnly>>\n      >\n  : MakeFieldsRequired<\n      Omit<InferSchemaType<Schema>, ExcludedFields<IdField, ReadOnly>>,\n      Exclude<AutoRequiredKeys<Schema>, ExcludedFields<IdField, ReadOnly>>\n    >;\n\nexport interface ExecuteOptions {\n  includeODataAnnotations?: boolean;\n  skipValidation?: boolean;\n  /**\n   * Overrides the default behavior of the database to use entity IDs (rather than field names) in THIS REQUEST ONLY\n   */\n  useEntityIds?: boolean;\n  /**\n   * Overrides the default behavior of the database to include special columns (ROWID and ROWMODID) in THIS REQUEST ONLY.\n   * Note: Special columns are only included when there is no $select query.\n   */\n  includeSpecialColumns?: boolean;\n}\n\n/**\n * Type for the fetchHandler callback function.\n * This is a convenience type export that matches the fetchHandler signature in FFetchOptions.\n *\n * @example\n * ```typescript\n * import type { FetchHandler } from '@proofkit/fmodata';\n *\n * const myFetchHandler: FetchHandler = (input, init) => {\n *   console.log('Custom fetch:', input);\n *   return fetch(input, init);\n * };\n *\n * await query.execute({\n *   fetchHandler: myFetchHandler\n * });\n * ```\n */\nexport type FetchHandler = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;\n\n/**\n * Combined type for execute() method options.\n *\n * Uses FFetchOptions from @fetchkit/ffetch to ensure proper type inference.\n * FFetchOptions is re-exported in the package to ensure type availability in consuming packages.\n */\nexport type ExecuteMethodOptions<EO extends ExecuteOptions = ExecuteOptions> = RequestInit &\n  FFetchOptions &\n  ExecuteOptions &\n  EO;\n\n/**\n * Get the Accept header value based on includeODataAnnotations option\n * @param includeODataAnnotations - Whether to include OData annotations\n * @returns Accept header value\n */\nexport function getAcceptHeader(includeODataAnnotations?: boolean): string {\n  return includeODataAnnotations === true ? \"application/json\" : \"application/json;odata.metadata=none\";\n}\n\nexport type ConditionallyWithODataAnnotations<\n  T,\n  IncludeODataAnnotations extends boolean,\n> = IncludeODataAnnotations extends true\n  ? T & {\n      \"@id\": string;\n      \"@editLink\": string;\n    }\n  : T;\n\n/**\n * Normalizes includeSpecialColumns with a database-level default.\n * Uses distributive conditional types to handle unions correctly.\n * @template IncludeSpecialColumns - The includeSpecialColumns value from execute options\n * @template DatabaseDefault - The database-level includeSpecialColumns setting (defaults to false)\n */\nexport type NormalizeIncludeSpecialColumns<\n  IncludeSpecialColumns extends boolean | undefined,\n  DatabaseDefault extends boolean = false,\n> = [IncludeSpecialColumns] extends [true] ? true : [IncludeSpecialColumns] extends [false] ? false : DatabaseDefault; // When undefined, use database-level default\n\n/**\n * Conditionally adds ROWID and ROWMODID special columns to a type.\n * Special columns are only included when:\n * - includeSpecialColumns is true AND\n * - hasSelect is false (no $select query was applied) AND\n * - T is an object type (not a primitive like string or number)\n *\n * Handles both single objects and arrays of objects.\n */\nexport type ConditionallyWithSpecialColumns<\n  T,\n  IncludeSpecialColumns extends boolean,\n  HasSelect extends boolean,\n> = IncludeSpecialColumns extends true\n  ? HasSelect extends false\n    ? // Handle array types\n      T extends readonly (infer U)[]\n      ? // biome-ignore lint/suspicious/noExplicitAny: Generic constraint accepting any record shape\n        U extends Record<string, any>\n        ? (U & {\n            ROWID: number;\n            ROWMODID: number;\n          })[]\n        : T\n      : // Handle single object types\n        // biome-ignore lint/suspicious/noExplicitAny: Generic constraint accepting any record shape\n        T extends Record<string, any>\n        ? T & {\n            ROWID: number;\n            ROWMODID: number;\n          }\n        : T // Don't add special columns to primitives (e.g., single field queries)\n    : T\n  : T;\n\n// Helper type to extract schema from a FMTable\nexport type ExtractSchemaFromOccurrence<Occ> = Occ extends {\n  baseTable: { schema: infer S };\n}\n  ? S extends Record<string, StandardSchemaV1>\n    ? S\n    : Record<string, StandardSchemaV1>\n  : Record<string, StandardSchemaV1>;\n\nexport interface GenericFieldMetadata {\n  $Nullable?: boolean;\n  \"@Index\"?: boolean;\n  \"@Calculation\"?: boolean;\n  \"@Summary\"?: boolean;\n  \"@Global\"?: boolean;\n  \"@Org.OData.Core.V1.Permissions\"?: \"Org.OData.Core.V1.Permission@Read\";\n}\n\nexport type StringFieldMetadata = GenericFieldMetadata & {\n  $Type: \"Edm.String\";\n  $DefaultValue?: \"USER\" | \"USERNAME\" | \"CURRENT_USER\";\n  $MaxLength?: number;\n};\n\nexport type DecimalFieldMetadata = GenericFieldMetadata & {\n  $Type: \"Edm.Decimal\";\n  \"@AutoGenerated\"?: boolean;\n};\n\nexport type DateFieldMetadata = GenericFieldMetadata & {\n  $Type: \"Edm.Date\";\n  $DefaultValue?: \"CURDATE\" | \"CURRENT_DATE\";\n};\n\nexport type TimeOfDayFieldMetadata = GenericFieldMetadata & {\n  $Type: \"Edm.TimeOfDay\";\n  $DefaultValue?: \"CURTIME\" | \"CURRENT_TIME\";\n};\n\nexport type DateTimeOffsetFieldMetadata = GenericFieldMetadata & {\n  $Type: \"Edm.Date\";\n  $DefaultValue?: \"CURTIMESTAMP\" | \"CURRENT_TIMESTAMP\";\n  \"@VersionId\"?: boolean;\n};\n\nexport interface StreamFieldMetadata {\n  $Type: \"Edm.Stream\";\n  $Nullable?: boolean;\n  \"@EnclosedPath\": string;\n  \"@ExternalOpenPath\": string;\n  \"@ExternalSecurePath\"?: string;\n}\n\nexport type FieldMetadata =\n  | StringFieldMetadata\n  | DecimalFieldMetadata\n  | DateFieldMetadata\n  | TimeOfDayFieldMetadata\n  | DateTimeOffsetFieldMetadata\n  | StreamFieldMetadata;\n\nexport type EntityType = {\n  $Kind: \"EntityType\";\n  $Key: string[];\n} & Record<string, FieldMetadata>;\n\nexport interface EntitySet {\n  $Kind: \"EntitySet\";\n  $Type: string;\n}\n\nexport type Metadata = Record<string, EntityType | EntitySet>;\n"],"names":[],"mappings":"AAsMO,SAAS,gBAAgB,yBAA2C;AAClE,SAAA,4BAA4B,OAAO,qBAAqB;AACjE;"}

package/dist/esm/validation.d.ts

@@ -1,21 +1,31 @@
-import { ODataRecordMetadata } from './types.js';
 import { StandardSchemaV1 } from '@standard-schema/spec';
-import { TableOccurrence } from './client/table-occurrence.js';
-import { ValidationError, ResponseStructureError, RecordCountMismatchError } from './errors.js';
-export type ExpandValidationConfig = {
+import { RecordCountMismatchError, ResponseStructureError, ValidationError } from './errors.js';
+import { FMTable } from './orm/table.js';
+import { ODataRecordMetadata } from './types.js';
+/**
+ * Validates and transforms input data for insert/update operations.
+ * Applies input validators (writeValidators) to transform user input to database format.
+ * Fields without input validators are passed through unchanged.
+ *
+ * @param data - The input data to validate and transform
+ * @param inputSchema - Optional schema containing input validators for each field
+ * @returns Transformed data ready to send to the server
+ * @throws ValidationError if any field fails validation
+ */
+export declare function validateAndTransformInput<T extends Record<string, any>>(data: Partial<T>, inputSchema?: Partial<Record<string, StandardSchemaV1>>): Promise<Partial<T>>;
+export interface ExpandValidationConfig {
     relation: string;
-    targetSchema?: Record<string, StandardSchemaV1>;
-    targetOccurrence?: TableOccurrence<any, any, any, any>;
-    targetBaseTable?: any;
-    occurrence?: TableOccurrence<any, any, any, any>;
+    targetSchema?: Partial<Record<string, StandardSchemaV1>>;
+    targetTable?: FMTable<any, any>;
+    table?: FMTable<any, any>;
     selectedFields?: string[];
     nestedExpands?: ExpandValidationConfig[];
-};
+}
 /**
  * Validates a single record against a schema, only validating selected fields.
  * Also validates expanded relations if expandConfigs are provided.
  */
-export declare function validateRecord<T extends Record<string, any>>(record: any, schema: Record<string, StandardSchemaV1> | undefined, selectedFields?: (keyof T)[], expandConfigs?: ExpandValidationConfig[]): Promise<{
+export declare function validateRecord<T extends Record<string, any>>(record: any, schema: Partial<Record<string, StandardSchemaV1>> | undefined, selectedFields?: (keyof T)[], expandConfigs?: ExpandValidationConfig[], includeSpecialColumns?: boolean): Promise<{
     valid: true;
     data: T & ODataRecordMetadata;
 } | {
@@ -25,7 +35,7 @@ export declare function validateRecord<T extends Record<string, any>>(record: an
 /**
  * Validates a list response against a schema.
  */
-export declare function validateListResponse<T extends Record<string, any>>(response: any, schema: Record<string, StandardSchemaV1> | undefined, selectedFields?: (keyof T)[], expandConfigs?: ExpandValidationConfig[]): Promise<{
+export declare function validateListResponse<T extends Record<string, any>>(response: any, schema: Partial<Record<string, StandardSchemaV1>> | undefined, selectedFields?: (keyof T)[], expandConfigs?: ExpandValidationConfig[], includeSpecialColumns?: boolean): Promise<{
     valid: true;
     data: (T & ODataRecordMetadata)[];
 } | {
@@ -35,7 +45,7 @@ export declare function validateListResponse<T extends Record<string, any>>(resp
 /**
  * Validates a single record response against a schema.
  */
-export declare function validateSingleResponse<T extends Record<string, any>>(response: any, schema: Record<string, StandardSchemaV1> | undefined, selectedFields?: (keyof T)[], expandConfigs?: ExpandValidationConfig[], mode?: "exact" | "maybe"): Promise<{
+export declare function validateSingleResponse<T extends Record<string, any>>(response: any, schema: Partial<Record<string, StandardSchemaV1>> | undefined, selectedFields?: (keyof T)[], expandConfigs?: ExpandValidationConfig[], mode?: "exact" | "maybe", includeSpecialColumns?: boolean): Promise<{
     valid: true;
     data: (T & ODataRecordMetadata) | null;
 } | {