@proofkit/fmodata 0.1.0-alpha.2 → 0.1.0-alpha.20

package/dist/esm/client/filemaker-odata.js

@@ -1,13 +1,22 @@
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-import createClient from "@fetchkit/ffetch";
+import createClient, { TimeoutError, AbortError, NetworkError, RetryLimitError, CircuitOpenError } from "@fetchkit/ffetch";
+import { getAcceptHeader } from "../types.js";
+import { SchemaLockedError, ODataError, HTTPError, ResponseParseError } from "../errors.js";
 import { Database } from "./database.js";
+import { safeJsonParse } from "./sanitize-json.js";
+import { get } from "es-toolkit/compat";
+import { createLogger } from "../logger.js";
 class FMServerConnection {
   constructor(config) {
     __publicField(this, "fetchClient");
     __publicField(this, "serverUrl");
     __publicField(this, "auth");
+    __publicField(this, "useEntityIds", false);
+    __publicField(this, "includeSpecialColumns", false);
+    __publicField(this, "logger");
+    this.logger = createLogger(config.logger);
     this.fetchClient = createClient({
       retries: 0,
       ...config.fetchClientOptions
@@ -20,18 +29,75 @@ class FMServerConnection {
     this.serverUrl = url.toString().replace(/\/+$/, "");
     this.auth = config.auth;
   }
+  /**
+   * @internal
+   * Sets whether to use FileMaker entity IDs (FMFID/FMTID) in requests
+   */
+  _setUseEntityIds(useEntityIds) {
+    this.useEntityIds = useEntityIds;
+  }
+  /**
+   * @internal
+   * Gets whether to use FileMaker entity IDs (FMFID/FMTID) in requests
+   */
+  _getUseEntityIds() {
+    return this.useEntityIds;
+  }
+  /**
+   * @internal
+   * Sets whether to include special columns (ROWID and ROWMODID) in requests
+   */
+  _setIncludeSpecialColumns(includeSpecialColumns) {
+    this.includeSpecialColumns = includeSpecialColumns;
+  }
+  /**
+   * @internal
+   * Gets whether to include special columns (ROWID and ROWMODID) in requests
+   */
+  _getIncludeSpecialColumns() {
+    return this.includeSpecialColumns;
+  }
+  /**
+   * @internal
+   * Gets the base URL for OData requests
+   */
+  _getBaseUrl() {
+    return `${this.serverUrl}${"apiKey" in this.auth ? `/otto` : ""}/fmi/odata/v4`;
+  }
+  /**
+   * @internal
+   * Gets the logger instance
+   */
+  _getLogger() {
+    return this.logger;
+  }
   /**
    * @internal
    */
   async _makeRequest(url, options) {
-    var _a;
+    var _a, _b, _c, _d, _e, _f;
+    const logger = this._getLogger();
     const baseUrl = `${this.serverUrl}${"apiKey" in this.auth ? `/otto` : ""}/fmi/odata/v4`;
+    const fullUrl = baseUrl + url;
+    const useEntityIds = (options == null ? void 0 : options.useEntityIds) ?? this.useEntityIds;
+    const includeSpecialColumns = (options == null ? void 0 : options.includeSpecialColumns) ?? this.includeSpecialColumns;
+    const includeODataAnnotations = options == null ? void 0 : options.includeODataAnnotations;
+    const preferValues = [];
+    if (useEntityIds) {
+      preferValues.push("fmodata.entity-ids");
+    }
+    if (includeSpecialColumns) {
+      preferValues.push("fmodata.include-specialcolumns");
+    }
     const headers = {
       Authorization: "apiKey" in this.auth ? `Bearer ${this.auth.apiKey}` : `Basic ${btoa(`${this.auth.username}:${this.auth.password}`)}`,
       "Content-Type": "application/json",
-      Accept: "application/json",
+      Accept: getAcceptHeader(includeODataAnnotations),
+      ...preferValues.length > 0 ? { Prefer: preferValues.join(", ") } : {},
       ...(options == null ? void 0 : options.headers) || {}
     };
+    const { Authorization, ...loggableHeaders } = headers;
+    logger.debug("Request headers:", loggableHeaders);
     const fetchHandler = options == null ? void 0 : options.fetchHandler;
     const {
       headers: _headers,
@@ -39,30 +105,105 @@ class FMServerConnection {
       ...restOptions
     } = options || {};
     const clientToUse = fetchHandler ? createClient({ retries: 0, fetchHandler }) : this.fetchClient;
-    const resp = await clientToUse(baseUrl + url, {
-      ...restOptions,
-      headers
-    });
-    if (!resp.ok) {
-      throw new Error(
-        `Failed to make request to ${baseUrl + url}: ${resp.statusText}`
-      );
-    }
-    const affectedRows = resp.headers.get("fmodata.affected_rows");
-    if (affectedRows !== null) {
-      return parseInt(affectedRows, 10);
-    }
-    if (resp.status === 204) {
-      return 0;
-    }
-    if ((_a = resp.headers.get("content-type")) == null ? void 0 : _a.includes("application/json")) {
-      let data = await resp.json();
-      if (data.error) {
-        throw new Error(data.error);
+    try {
+      const finalOptions = {
+        ...restOptions,
+        headers
+      };
+      const resp = await clientToUse(fullUrl, finalOptions);
+      logger.debug(`${finalOptions.method ?? "GET"} ${resp.status} ${fullUrl}`);
+      if (!resp.ok) {
+        let errorBody;
+        try {
+          if ((_a = resp.headers.get("content-type")) == null ? void 0 : _a.includes("application/json")) {
+            errorBody = await safeJsonParse(resp);
+          }
+        } catch {
+        }
+        if (errorBody == null ? void 0 : errorBody.error) {
+          const errorCode = errorBody.error.code;
+          const errorMessage = errorBody.error.message || resp.statusText;
+          if (errorCode === "303" || errorCode === 303) {
+            return {
+              data: void 0,
+              error: new SchemaLockedError(
+                fullUrl,
+                errorMessage,
+                errorBody.error
+              )
+            };
+          }
+          return {
+            data: void 0,
+            error: new ODataError(
+              fullUrl,
+              errorMessage,
+              String(errorCode),
+              errorBody.error
+            )
+          };
+        }
+        return {
+          data: void 0,
+          error: new HTTPError(
+            fullUrl,
+            resp.status,
+            resp.statusText,
+            errorBody
+          )
+        };
+      }
+      const affectedRows = resp.headers.get("fmodata.affected_rows");
+      if (affectedRows !== null) {
+        return { data: parseInt(affectedRows, 10), error: void 0 };
+      }
+      if (resp.status === 204) {
+        const locationHeader = ((_c = (_b = resp.headers) == null ? void 0 : _b.get) == null ? void 0 : _c.call(_b, "Location")) || ((_e = (_d = resp.headers) == null ? void 0 : _d.get) == null ? void 0 : _e.call(_d, "location"));
+        if (locationHeader) {
+          return { data: { _location: locationHeader }, error: void 0 };
+        }
+        return { data: 0, error: void 0 };
       }
-      return data;
+      if ((_f = resp.headers.get("content-type")) == null ? void 0 : _f.includes("application/json")) {
+        const data = await safeJsonParse(resp);
+        if (get(data, "error", null)) {
+          const errorCode = get(data, "error.code", null);
+          const errorMessage = get(
+            data,
+            "error.message",
+            "Unknown OData error"
+          );
+          if (errorCode === "303" || errorCode === 303) {
+            return {
+              data: void 0,
+              error: new SchemaLockedError(fullUrl, errorMessage, data.error)
+            };
+          }
+          return {
+            data: void 0,
+            error: new ODataError(
+              fullUrl,
+              errorMessage,
+              String(errorCode),
+              data.error
+            )
+          };
+        }
+        return { data, error: void 0 };
+      }
+      return { data: await resp.text(), error: void 0 };
+    } catch (err) {
+      if (err instanceof TimeoutError || err instanceof AbortError || err instanceof NetworkError || err instanceof RetryLimitError || err instanceof CircuitOpenError) {
+        return { data: void 0, error: err };
+      }
+      if (err instanceof ResponseParseError) {
+        return { data: void 0, error: err };
+      }
+      return {
+        data: void 0,
+        error: new NetworkError(fullUrl, err)
+      };
     }
-    return await resp.text();
   }
   database(name, config) {
     return new Database(name, this, config);
@@ -72,9 +213,12 @@ class FMServerConnection {
    * @returns Promise resolving to an array of database names
    */
   async listDatabaseNames() {
-    const response = await this._makeRequest("/");
-    if (response.value && Array.isArray(response.value)) {
-      return response.value.map((item) => item.name);
+    const result = await this._makeRequest("/$metadata", { headers: { Accept: "application/json" } });
+    if (result.error) {
+      throw result.error;
+    }
+    if (result.data.value && Array.isArray(result.data.value)) {
+      return result.data.value.map((item) => item.name);
     }
     return [];
   }

package/dist/esm/client/filemaker-odata.js.map

@@ -1 +1 @@
-{"version":3,"file":"filemaker-odata.js","sources":["../../../src/client/filemaker-odata.ts"],"sourcesContent":["import createClient, { FFetchOptions } from \"@fetchkit/ffetch\";\nimport type { Auth, ExecutionContext } from \"../types\";\nimport { Database } from \"./database\";\nimport { TableOccurrence } from \"./table-occurrence\";\n\nexport class FMServerConnection implements ExecutionContext {\n  private fetchClient: ReturnType<typeof createClient>;\n  private serverUrl: string;\n  private auth: Auth;\n  constructor(config: {\n    serverUrl: string;\n    auth: Auth;\n    fetchClientOptions?: FFetchOptions;\n  }) {\n    this.fetchClient = createClient({\n      retries: 0,\n      ...config.fetchClientOptions,\n    });\n    // Ensure the URL uses https://, is valid, and has no trailing slash\n    const url = new URL(config.serverUrl);\n    if (url.protocol !== \"https:\") {\n      url.protocol = \"https:\";\n    }\n    // Remove any trailing slash from pathname\n    url.pathname = url.pathname.replace(/\\/+$/, \"\");\n    this.serverUrl = url.toString().replace(/\\/+$/, \"\");\n    this.auth = config.auth;\n  }\n\n  /**\n   * @internal\n   */\n  async _makeRequest<T>(\n    url: string,\n    options?: RequestInit & FFetchOptions,\n  ): Promise<T> {\n    const baseUrl = `${this.serverUrl}${\"apiKey\" in this.auth ? `/otto` : \"\"}/fmi/odata/v4`;\n\n    const headers = {\n      Authorization:\n        \"apiKey\" in this.auth\n          ? `Bearer ${this.auth.apiKey}`\n          : `Basic ${btoa(`${this.auth.username}:${this.auth.password}`)}`,\n      \"Content-Type\": \"application/json\",\n      Accept: \"application/json\",\n      ...(options?.headers || {}),\n    };\n\n    // TEMPORARY WORKAROUND: Hopefully this feature will be fixed in the ffetch library\n    // Extract fetchHandler and headers separately, only for tests where we're overriding the fetch handler per-request\n    const fetchHandler = options?.fetchHandler;\n    const {\n      headers: _headers,\n      fetchHandler: _fetchHandler,\n      ...restOptions\n    } = options || {};\n\n    // If fetchHandler is provided, create a temporary client with it\n    // Otherwise use the existing client\n    const clientToUse = fetchHandler\n      ? createClient({ retries: 0, fetchHandler })\n      : this.fetchClient;\n\n    const resp = await clientToUse(baseUrl + url, {\n      ...restOptions,\n      headers,\n    });\n\n    if (!resp.ok) {\n      throw new Error(\n        `Failed to make request to ${baseUrl + url}: ${resp.statusText}`,\n      );\n    }\n\n    // Check for affected rows header (for DELETE and bulk PATCH operations)\n    // FileMaker may return this with 204 No Content or 200 OK\n    const affectedRows = resp.headers.get(\"fmodata.affected_rows\");\n    if (affectedRows !== null) {\n      return parseInt(affectedRows, 10) as T;\n    }\n\n    // Handle 204 No Content with no body\n    if (resp.status === 204) {\n      return 0 as T;\n    }\n\n    if (resp.headers.get(\"content-type\")?.includes(\"application/json\")) {\n      let data = await resp.json();\n      if (data.error) {\n        throw new Error(data.error);\n      }\n      return data as T;\n    }\n    return (await resp.text()) as T;\n  }\n\n  database<\n    const Occurrences extends readonly TableOccurrence<any, any, any, any>[],\n  >(\n    name: string,\n    config?: { occurrences?: Occurrences },\n  ): Database<Occurrences> {\n    return new Database(name, this, config);\n  }\n\n  /**\n   * Lists all available databases from the FileMaker OData service.\n   * @returns Promise resolving to an array of database names\n   */\n  async listDatabaseNames(): Promise<string[]> {\n    const response = (await this._makeRequest(\"/\")) as {\n      value?: Array<{ name: string }>;\n    };\n    if (response.value && Array.isArray(response.value)) {\n      return response.value.map((item) => item.name);\n    }\n    return [];\n  }\n}\n"],"names":[],"mappings":";;;;;AAKO,MAAM,mBAA+C;AAAA,EAI1D,YAAY,QAIT;AAPK;AACA;AACA;AAMN,SAAK,cAAc,aAAa;AAAA,MAC9B,SAAS;AAAA,MACT,GAAG,OAAO;AAAA,IAAA,CACX;AAED,UAAM,MAAM,IAAI,IAAI,OAAO,SAAS;AAChC,QAAA,IAAI,aAAa,UAAU;AAC7B,UAAI,WAAW;AAAA,IAAA;AAGjB,QAAI,WAAW,IAAI,SAAS,QAAQ,QAAQ,EAAE;AAC9C,SAAK,YAAY,IAAI,SAAW,EAAA,QAAQ,QAAQ,EAAE;AAClD,SAAK,OAAO,OAAO;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMrB,MAAM,aACJ,KACA,SACY;;AACN,UAAA,UAAU,GAAG,KAAK,SAAS,GAAG,YAAY,KAAK,OAAO,UAAU,EAAE;AAExE,UAAM,UAAU;AAAA,MACd,eACE,YAAY,KAAK,OACb,UAAU,KAAK,KAAK,MAAM,KAC1B,SAAS,KAAK,GAAG,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;AAAA,MAClE,gBAAgB;AAAA,MAChB,QAAQ;AAAA,MACR,IAAI,mCAAS,YAAW,CAAA;AAAA,IAC1B;AAIA,UAAM,eAAe,mCAAS;AACxB,UAAA;AAAA,MACJ,SAAS;AAAA,MACT,cAAc;AAAA,MACd,GAAG;AAAA,IACL,IAAI,WAAW,CAAC;AAIV,UAAA,cAAc,eAChB,aAAa,EAAE,SAAS,GAAG,aAAA,CAAc,IACzC,KAAK;AAET,UAAM,OAAO,MAAM,YAAY,UAAU,KAAK;AAAA,MAC5C,GAAG;AAAA,MACH;AAAA,IAAA,CACD;AAEG,QAAA,CAAC,KAAK,IAAI;AACZ,YAAM,IAAI;AAAA,QACR,6BAA6B,UAAU,GAAG,KAAK,KAAK,UAAU;AAAA,MAChE;AAAA,IAAA;AAKF,UAAM,eAAe,KAAK,QAAQ,IAAI,uBAAuB;AAC7D,QAAI,iBAAiB,MAAM;AAClB,aAAA,SAAS,cAAc,EAAE;AAAA,IAAA;AAI9B,QAAA,KAAK,WAAW,KAAK;AAChB,aAAA;AAAA,IAAA;AAGT,SAAI,UAAK,QAAQ,IAAI,cAAc,MAA/B,mBAAkC,SAAS,qBAAqB;AAC9D,UAAA,OAAO,MAAM,KAAK,KAAK;AAC3B,UAAI,KAAK,OAAO;AACR,cAAA,IAAI,MAAM,KAAK,KAAK;AAAA,MAAA;AAErB,aAAA;AAAA,IAAA;AAED,WAAA,MAAM,KAAK,KAAK;AAAA,EAAA;AAAA,EAG1B,SAGE,MACA,QACuB;AACvB,WAAO,IAAI,SAAS,MAAM,MAAM,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOxC,MAAM,oBAAuC;AAC3C,UAAM,WAAY,MAAM,KAAK,aAAa,GAAG;AAG7C,QAAI,SAAS,SAAS,MAAM,QAAQ,SAAS,KAAK,GAAG;AACnD,aAAO,SAAS,MAAM,IAAI,CAAC,SAAS,KAAK,IAAI;AAAA,IAAA;AAE/C,WAAO,CAAC;AAAA,EAAA;AAEZ;"}
+{"version":3,"file":"filemaker-odata.js","sources":["../../../src/client/filemaker-odata.ts"],"sourcesContent":["import createClient, {\n  FFetchOptions,\n  TimeoutError,\n  AbortError,\n  NetworkError,\n  RetryLimitError,\n  CircuitOpenError,\n} from \"@fetchkit/ffetch\";\nimport type { Auth, ExecutionContext, Result } from \"../types\";\nimport { getAcceptHeader } from \"../types\";\nimport {\n  HTTPError,\n  ODataError,\n  SchemaLockedError,\n  ResponseParseError,\n} from \"../errors\";\nimport { Database } from \"./database\";\nimport { safeJsonParse } from \"./sanitize-json\";\nimport { get } from \"es-toolkit/compat\";\nimport { createLogger, type Logger, type InternalLogger } from \"../logger\";\n\nexport class FMServerConnection implements ExecutionContext {\n  private fetchClient: ReturnType<typeof createClient>;\n  private serverUrl: string;\n  private auth: Auth;\n  private useEntityIds: boolean = false;\n  private includeSpecialColumns: boolean = false;\n  private logger: InternalLogger;\n  constructor(config: {\n    serverUrl: string;\n    auth: Auth;\n    fetchClientOptions?: FFetchOptions;\n    logger?: Logger;\n  }) {\n    this.logger = createLogger(config.logger);\n    this.fetchClient = createClient({\n      retries: 0,\n      ...config.fetchClientOptions,\n    });\n    // Ensure the URL uses https://, is valid, and has no trailing slash\n    const url = new URL(config.serverUrl);\n    if (url.protocol !== \"https:\") {\n      url.protocol = \"https:\";\n    }\n    // Remove any trailing slash from pathname\n    url.pathname = url.pathname.replace(/\\/+$/, \"\");\n    this.serverUrl = url.toString().replace(/\\/+$/, \"\");\n    this.auth = config.auth;\n  }\n\n  /**\n   * @internal\n   * Sets whether to use FileMaker entity IDs (FMFID/FMTID) in requests\n   */\n  _setUseEntityIds(useEntityIds: boolean): void {\n    this.useEntityIds = useEntityIds;\n  }\n\n  /**\n   * @internal\n   * Gets whether to use FileMaker entity IDs (FMFID/FMTID) in requests\n   */\n  _getUseEntityIds(): boolean {\n    return this.useEntityIds;\n  }\n\n  /**\n   * @internal\n   * Sets whether to include special columns (ROWID and ROWMODID) in requests\n   */\n  _setIncludeSpecialColumns(includeSpecialColumns: boolean): void {\n    this.includeSpecialColumns = includeSpecialColumns;\n  }\n\n  /**\n   * @internal\n   * Gets whether to include special columns (ROWID and ROWMODID) in requests\n   */\n  _getIncludeSpecialColumns(): boolean {\n    return this.includeSpecialColumns;\n  }\n\n  /**\n   * @internal\n   * Gets the base URL for OData requests\n   */\n  _getBaseUrl(): string {\n    return `${this.serverUrl}${\"apiKey\" in this.auth ? `/otto` : \"\"}/fmi/odata/v4`;\n  }\n\n  /**\n   * @internal\n   * Gets the logger instance\n   */\n  _getLogger(): InternalLogger {\n    return this.logger;\n  }\n\n  /**\n   * @internal\n   */\n  async _makeRequest<T>(\n    url: string,\n    options?: RequestInit &\n      FFetchOptions & {\n        useEntityIds?: boolean;\n        includeSpecialColumns?: boolean;\n      },\n  ): Promise<Result<T>> {\n    const logger = this._getLogger();\n    const baseUrl = `${this.serverUrl}${\"apiKey\" in this.auth ? `/otto` : \"\"}/fmi/odata/v4`;\n    const fullUrl = baseUrl + url;\n\n    // Use per-request override if provided, otherwise use the database-level setting\n    const useEntityIds = options?.useEntityIds ?? this.useEntityIds;\n    const includeSpecialColumns =\n      options?.includeSpecialColumns ?? this.includeSpecialColumns;\n\n    // Get includeODataAnnotations from options (it's passed through from execute options)\n    const includeODataAnnotations = (options as any)?.includeODataAnnotations;\n\n    // Build Prefer header as comma-separated list when multiple preferences are set\n    const preferValues: string[] = [];\n    if (useEntityIds) {\n      preferValues.push(\"fmodata.entity-ids\");\n    }\n    if (includeSpecialColumns) {\n      preferValues.push(\"fmodata.include-specialcolumns\");\n    }\n\n    const headers = {\n      Authorization:\n        \"apiKey\" in this.auth\n          ? `Bearer ${this.auth.apiKey}`\n          : `Basic ${btoa(`${this.auth.username}:${this.auth.password}`)}`,\n      \"Content-Type\": \"application/json\",\n      Accept: getAcceptHeader(includeODataAnnotations),\n      ...(preferValues.length > 0 ? { Prefer: preferValues.join(\", \") } : {}),\n      ...(options?.headers || {}),\n    };\n\n    // Prepare loggableHeaders by omitting the Authorization key\n    const { Authorization, ...loggableHeaders } = headers;\n    logger.debug(\"Request headers:\", loggableHeaders);\n\n    // TEMPORARY WORKAROUND: Hopefully this feature will be fixed in the ffetch library\n    // Extract fetchHandler and headers separately, only for tests where we're overriding the fetch handler per-request\n    const fetchHandler = options?.fetchHandler;\n    const {\n      headers: _headers,\n      fetchHandler: _fetchHandler,\n      ...restOptions\n    } = options || {};\n\n    // If fetchHandler is provided, create a temporary client with it\n    // Otherwise use the existing client\n    const clientToUse = fetchHandler\n      ? createClient({ retries: 0, fetchHandler })\n      : this.fetchClient;\n\n    try {\n      const finalOptions = {\n        ...restOptions,\n        headers,\n      };\n\n      const resp = await clientToUse(fullUrl, finalOptions);\n      logger.debug(`${finalOptions.method ?? \"GET\"} ${resp.status} ${fullUrl}`);\n\n      // Handle HTTP errors\n      if (!resp.ok) {\n        // Try to parse error body if it's JSON\n        let errorBody:\n          | { error?: { code?: string | number; message?: string } }\n          | undefined;\n        try {\n          if (resp.headers.get(\"content-type\")?.includes(\"application/json\")) {\n            errorBody = await safeJsonParse<typeof errorBody>(resp);\n          }\n        } catch {\n          // Ignore JSON parse errors\n        }\n\n        // Check if it's an OData error response\n        if (errorBody?.error) {\n          const errorCode = errorBody.error.code;\n          const errorMessage = errorBody.error.message || resp.statusText;\n\n          // Check for schema locked error (code 303)\n          if (errorCode === \"303\" || errorCode === 303) {\n            return {\n              data: undefined,\n              error: new SchemaLockedError(\n                fullUrl,\n                errorMessage,\n                errorBody.error,\n              ),\n            };\n          }\n\n          return {\n            data: undefined,\n            error: new ODataError(\n              fullUrl,\n              errorMessage,\n              String(errorCode),\n              errorBody.error,\n            ),\n          };\n        }\n\n        return {\n          data: undefined,\n          error: new HTTPError(\n            fullUrl,\n            resp.status,\n            resp.statusText,\n            errorBody,\n          ),\n        };\n      }\n\n      // Check for affected rows header (for DELETE and bulk PATCH operations)\n      // FileMaker may return this with 204 No Content or 200 OK\n      const affectedRows = resp.headers.get(\"fmodata.affected_rows\");\n      if (affectedRows !== null) {\n        return { data: parseInt(affectedRows, 10) as T, error: undefined };\n      }\n\n      // Handle 204 No Content with no body\n      if (resp.status === 204) {\n        // Check for Location header (used for insert with return=minimal)\n        // Use optional chaining for safety with mocks that might not have proper headers\n        const locationHeader =\n          resp.headers?.get?.(\"Location\") || resp.headers?.get?.(\"location\");\n        if (locationHeader) {\n          // Return the location header so InsertBuilder can extract ROWID\n          return { data: { _location: locationHeader } as T, error: undefined };\n        }\n        return { data: 0 as T, error: undefined };\n      }\n\n      // Parse response\n      if (resp.headers.get(\"content-type\")?.includes(\"application/json\")) {\n        const data = await safeJsonParse<\n          T & { error?: { code?: string | number; message?: string } }\n        >(resp);\n\n        // Check for embedded OData errors\n        if (get(data, \"error\", null)) {\n          const errorCode = get(data, \"error.code\", null);\n          const errorMessage = get(\n            data,\n            \"error.message\",\n            \"Unknown OData error\",\n          );\n\n          // Check for schema locked error (code 303)\n          if (errorCode === \"303\" || errorCode === 303) {\n            return {\n              data: undefined,\n              error: new SchemaLockedError(fullUrl, errorMessage, data.error),\n            };\n          }\n\n          return {\n            data: undefined,\n            error: new ODataError(\n              fullUrl,\n              errorMessage,\n              String(errorCode),\n              data.error,\n            ),\n          };\n        }\n\n        return { data: data as T, error: undefined };\n      }\n\n      return { data: (await resp.text()) as T, error: undefined };\n    } catch (err) {\n      // Map ffetch errors - return them directly (no re-wrapping)\n      if (\n        err instanceof TimeoutError ||\n        err instanceof AbortError ||\n        err instanceof NetworkError ||\n        err instanceof RetryLimitError ||\n        err instanceof CircuitOpenError\n      ) {\n        return { data: undefined, error: err };\n      }\n\n      // Handle JSON parse errors (ResponseParseError from safeJsonParse)\n      if (err instanceof ResponseParseError) {\n        return { data: undefined, error: err };\n      }\n\n      // Unknown error - wrap it as NetworkError\n      return {\n        data: undefined,\n        error: new NetworkError(fullUrl, err),\n      };\n    }\n  }\n\n  database<IncludeSpecialColumns extends boolean = false>(\n    name: string,\n    config?: {\n      useEntityIds?: boolean;\n      includeSpecialColumns?: IncludeSpecialColumns;\n    },\n  ): Database<IncludeSpecialColumns> {\n    return new Database<IncludeSpecialColumns>(name, this, config);\n  }\n\n  /**\n   * Lists all available databases from the FileMaker OData service.\n   * @returns Promise resolving to an array of database names\n   */\n  async listDatabaseNames(): Promise<string[]> {\n    const result = await this._makeRequest<{\n      value?: Array<{ name: string }>;\n    }>(\"/$metadata\", { headers: { Accept: \"application/json\" } });\n    if (result.error) {\n      throw result.error;\n    }\n    if (result.data.value && Array.isArray(result.data.value)) {\n      return result.data.value.map((item) => item.name);\n    }\n    return [];\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;;AAqBO,MAAM,mBAA+C;AAAA,EAO1D,YAAY,QAKT;AAXK;AACA;AACA;AACA,wCAAwB;AACxB,iDAAiC;AACjC;AAOD,SAAA,SAAS,aAAa,OAAO,MAAM;AACxC,SAAK,cAAc,aAAa;AAAA,MAC9B,SAAS;AAAA,MACT,GAAG,OAAO;AAAA,IAAA,CACX;AAED,UAAM,MAAM,IAAI,IAAI,OAAO,SAAS;AAChC,QAAA,IAAI,aAAa,UAAU;AAC7B,UAAI,WAAW;AAAA,IAAA;AAGjB,QAAI,WAAW,IAAI,SAAS,QAAQ,QAAQ,EAAE;AAC9C,SAAK,YAAY,IAAI,SAAW,EAAA,QAAQ,QAAQ,EAAE;AAClD,SAAK,OAAO,OAAO;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOrB,iBAAiB,cAA6B;AAC5C,SAAK,eAAe;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOtB,mBAA4B;AAC1B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOd,0BAA0B,uBAAsC;AAC9D,SAAK,wBAAwB;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO/B,4BAAqC;AACnC,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOd,cAAsB;AACb,WAAA,GAAG,KAAK,SAAS,GAAG,YAAY,KAAK,OAAO,UAAU,EAAE;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOjE,aAA6B;AAC3B,WAAO,KAAK;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMd,MAAM,aACJ,KACA,SAKoB;;AACd,UAAA,SAAS,KAAK,WAAW;AACzB,UAAA,UAAU,GAAG,KAAK,SAAS,GAAG,YAAY,KAAK,OAAO,UAAU,EAAE;AACxE,UAAM,UAAU,UAAU;AAGpB,UAAA,gBAAe,mCAAS,iBAAgB,KAAK;AAC7C,UAAA,yBACJ,mCAAS,0BAAyB,KAAK;AAGzC,UAAM,0BAA2B,mCAAiB;AAGlD,UAAM,eAAyB,CAAC;AAChC,QAAI,cAAc;AAChB,mBAAa,KAAK,oBAAoB;AAAA,IAAA;AAExC,QAAI,uBAAuB;AACzB,mBAAa,KAAK,gCAAgC;AAAA,IAAA;AAGpD,UAAM,UAAU;AAAA,MACd,eACE,YAAY,KAAK,OACb,UAAU,KAAK,KAAK,MAAM,KAC1B,SAAS,KAAK,GAAG,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;AAAA,MAClE,gBAAgB;AAAA,MAChB,QAAQ,gBAAgB,uBAAuB;AAAA,MAC/C,GAAI,aAAa,SAAS,IAAI,EAAE,QAAQ,aAAa,KAAK,IAAI,EAAE,IAAI,CAAC;AAAA,MACrE,IAAI,mCAAS,YAAW,CAAA;AAAA,IAC1B;AAGA,UAAM,EAAE,eAAe,GAAG,gBAAA,IAAoB;AACvC,WAAA,MAAM,oBAAoB,eAAe;AAIhD,UAAM,eAAe,mCAAS;AACxB,UAAA;AAAA,MACJ,SAAS;AAAA,MACT,cAAc;AAAA,MACd,GAAG;AAAA,IACL,IAAI,WAAW,CAAC;AAIV,UAAA,cAAc,eAChB,aAAa,EAAE,SAAS,GAAG,aAAA,CAAc,IACzC,KAAK;AAEL,QAAA;AACF,YAAM,eAAe;AAAA,QACnB,GAAG;AAAA,QACH;AAAA,MACF;AAEA,YAAM,OAAO,MAAM,YAAY,SAAS,YAAY;AAC7C,aAAA,MAAM,GAAG,aAAa,UAAU,KAAK,IAAI,KAAK,MAAM,IAAI,OAAO,EAAE;AAGpE,UAAA,CAAC,KAAK,IAAI;AAER,YAAA;AAGA,YAAA;AACF,eAAI,UAAK,QAAQ,IAAI,cAAc,MAA/B,mBAAkC,SAAS,qBAAqB;AACtD,wBAAA,MAAM,cAAgC,IAAI;AAAA,UAAA;AAAA,QACxD,QACM;AAAA,QAAA;AAKR,YAAI,uCAAW,OAAO;AACd,gBAAA,YAAY,UAAU,MAAM;AAClC,gBAAM,eAAe,UAAU,MAAM,WAAW,KAAK;AAGjD,cAAA,cAAc,SAAS,cAAc,KAAK;AACrC,mBAAA;AAAA,cACL,MAAM;AAAA,cACN,OAAO,IAAI;AAAA,gBACT;AAAA,gBACA;AAAA,gBACA,UAAU;AAAA,cAAA;AAAA,YAEd;AAAA,UAAA;AAGK,iBAAA;AAAA,YACL,MAAM;AAAA,YACN,OAAO,IAAI;AAAA,cACT;AAAA,cACA;AAAA,cACA,OAAO,SAAS;AAAA,cAChB,UAAU;AAAA,YAAA;AAAA,UAEd;AAAA,QAAA;AAGK,eAAA;AAAA,UACL,MAAM;AAAA,UACN,OAAO,IAAI;AAAA,YACT;AAAA,YACA,KAAK;AAAA,YACL,KAAK;AAAA,YACL;AAAA,UAAA;AAAA,QAEJ;AAAA,MAAA;AAKF,YAAM,eAAe,KAAK,QAAQ,IAAI,uBAAuB;AAC7D,UAAI,iBAAiB,MAAM;AACzB,eAAO,EAAE,MAAM,SAAS,cAAc,EAAE,GAAQ,OAAO,OAAU;AAAA,MAAA;AAI/D,UAAA,KAAK,WAAW,KAAK;AAGjB,cAAA,mBACJ,gBAAK,YAAL,mBAAc,QAAd,4BAAoB,kBAAe,gBAAK,YAAL,mBAAc,QAAd,4BAAoB;AACzD,YAAI,gBAAgB;AAElB,iBAAO,EAAE,MAAM,EAAE,WAAW,eAAe,GAAQ,OAAO,OAAU;AAAA,QAAA;AAEtE,eAAO,EAAE,MAAM,GAAQ,OAAO,OAAU;AAAA,MAAA;AAI1C,WAAI,UAAK,QAAQ,IAAI,cAAc,MAA/B,mBAAkC,SAAS,qBAAqB;AAC5D,cAAA,OAAO,MAAM,cAEjB,IAAI;AAGN,YAAI,IAAI,MAAM,SAAS,IAAI,GAAG;AAC5B,gBAAM,YAAY,IAAI,MAAM,cAAc,IAAI;AAC9C,gBAAM,eAAe;AAAA,YACnB;AAAA,YACA;AAAA,YACA;AAAA,UACF;AAGI,cAAA,cAAc,SAAS,cAAc,KAAK;AACrC,mBAAA;AAAA,cACL,MAAM;AAAA,cACN,OAAO,IAAI,kBAAkB,SAAS,cAAc,KAAK,KAAK;AAAA,YAChE;AAAA,UAAA;AAGK,iBAAA;AAAA,YACL,MAAM;AAAA,YACN,OAAO,IAAI;AAAA,cACT;AAAA,cACA;AAAA,cACA,OAAO,SAAS;AAAA,cAChB,KAAK;AAAA,YAAA;AAAA,UAET;AAAA,QAAA;AAGK,eAAA,EAAE,MAAiB,OAAO,OAAU;AAAA,MAAA;AAG7C,aAAO,EAAE,MAAO,MAAM,KAAK,KAAK,GAAS,OAAO,OAAU;AAAA,aACnD,KAAK;AAGV,UAAA,eAAe,gBACf,eAAe,cACf,eAAe,gBACf,eAAe,mBACf,eAAe,kBACf;AACA,eAAO,EAAE,MAAM,QAAW,OAAO,IAAI;AAAA,MAAA;AAIvC,UAAI,eAAe,oBAAoB;AACrC,eAAO,EAAE,MAAM,QAAW,OAAO,IAAI;AAAA,MAAA;AAIhC,aAAA;AAAA,QACL,MAAM;AAAA,QACN,OAAO,IAAI,aAAa,SAAS,GAAG;AAAA,MACtC;AAAA,IAAA;AAAA,EACF;AAAA,EAGF,SACE,MACA,QAIiC;AACjC,WAAO,IAAI,SAAgC,MAAM,MAAM,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO/D,MAAM,oBAAuC;AACrC,UAAA,SAAS,MAAM,KAAK,aAEvB,cAAc,EAAE,SAAS,EAAE,QAAQ,mBAAmB,GAAG;AAC5D,QAAI,OAAO,OAAO;AAChB,YAAM,OAAO;AAAA,IAAA;AAEX,QAAA,OAAO,KAAK,SAAS,MAAM,QAAQ,OAAO,KAAK,KAAK,GAAG;AACzD,aAAO,OAAO,KAAK,MAAM,IAAI,CAAC,SAAS,KAAK,IAAI;AAAA,IAAA;AAElD,WAAO,CAAC;AAAA,EAAA;AAEZ;"}

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

@@ -1,23 +1,53 @@
-import { ExecutionContext, ExecutableBuilder, Result, ODataRecordMetadata } from '../types.js';
-import { TableOccurrence } from './table-occurrence.js';
-import { FFetchOptions } from '@fetchkit/ffetch';
-export declare class InsertBuilder<T extends Record<string, any>, Occ extends TableOccurrence<any, any, any, any> | undefined = undefined> implements ExecutableBuilder<T & ODataRecordMetadata> {
-    private occurrence?;
-    private tableName;
+import { ExecutionContext, ExecutableBuilder, Result, ExecuteOptions, ConditionallyWithODataAnnotations, ExecuteMethodOptions } from '../types.js';
+import { FMTable, InferSchemaOutputFromFMTable } from '../orm/table.js';
+export type InsertOptions = {
+    return?: "minimal" | "representation";
+};
+export declare class InsertBuilder<Occ extends FMTable<any, any> | undefined = undefined, ReturnPreference extends "minimal" | "representation" = "representation"> implements ExecutableBuilder<ReturnPreference extends "minimal" ? {
+    ROWID: number;
+} : InferSchemaOutputFromFMTable<NonNullable<Occ>>> {
+    private table?;
     private databaseName;
     private context;
     private data;
+    private returnPreference;
+    private databaseUseEntityIds;
+    private databaseIncludeSpecialColumns;
     constructor(config: {
         occurrence?: Occ;
-        tableName: string;
         databaseName: string;
         context: ExecutionContext;
-        data: Partial<T>;
+        data: Partial<InferSchemaOutputFromFMTable<NonNullable<Occ>>>;
+        returnPreference?: ReturnPreference;
+        databaseUseEntityIds?: boolean;
+        databaseIncludeSpecialColumns?: boolean;
     });
-    execute(options?: RequestInit & FFetchOptions): Promise<Result<T & ODataRecordMetadata>>;
+    /**
+     * Helper to merge database-level useEntityIds with per-request options
+     */
+    private mergeExecuteOptions;
+    /**
+     * Parse ROWID from Location header
+     * Expected formats:
+     * - contacts(ROWID=4583)
+     * - contacts('some-uuid')
+     */
+    private parseLocationHeader;
+    /**
+     * Gets the table ID (FMTID) if using entity IDs, otherwise returns the table name
+     * @param useEntityIds - Optional override for entity ID usage
+     */
+    private getTableId;
+    execute<EO extends ExecuteOptions>(options?: ExecuteMethodOptions<EO>): Promise<Result<ReturnPreference extends "minimal" ? {
+        ROWID: number;
+    } : ConditionallyWithODataAnnotations<InferSchemaOutputFromFMTable<NonNullable<Occ>>, EO["includeODataAnnotations"] extends true ? true : false>>>;
     getRequestConfig(): {
         method: string;
         url: string;
         body?: any;
     };
+    toRequest(baseUrl: string, options?: ExecuteOptions): Request;
+    processResponse(response: Response, options?: ExecuteOptions): Promise<Result<ReturnPreference extends "minimal" ? {
+        ROWID: number;
+    } : InferSchemaOutputFromFMTable<NonNullable<Occ>>>>;
 }