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

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

@@ -0,0 +1,126 @@
+import { FMTable } from '../orm.js';
+import { ExecutionContext, ExecuteMethodOptions } from '../types.js';
+import { FilterExpression } from '../orm/operators.js';
+import { Column } from '../orm/column.js';
+export type Webhook<TableName = string> = {
+    webhook: string;
+    headers?: Record<string, string>;
+    tableName: TableName;
+    notifySchemaChanges?: boolean;
+    select?: string | Column<any, any, any>[];
+    filter?: string | FilterExpression;
+};
+/**
+ * Webhook information returned by the API
+ */
+export type WebhookInfo = {
+    webHookID: number;
+    tableName: string;
+    url: string;
+    headers?: Record<string, string>;
+    notifySchemaChanges: boolean;
+    select: string;
+    filter: string;
+    pendingOperations: unknown[];
+};
+/**
+ * Response from listing all webhooks
+ */
+export type WebhookListResponse = {
+    Status: string;
+    WebHook: WebhookInfo[];
+};
+/**
+ * Response from adding a webhook
+ */
+export type WebhookAddResponse = {
+    webHookResult: {
+        webHookID: number;
+    };
+};
+export declare class WebhookManager {
+    private readonly databaseName;
+    private readonly context;
+    constructor(databaseName: string, context: ExecutionContext);
+    /**
+     * Adds a new webhook to the database.
+     * @param webhook - The webhook configuration object
+     * @param webhook.webhook - The webhook URL to call
+     * @param webhook.tableName - The FMTable instance for the table to monitor
+     * @param webhook.headers - Optional custom headers to include in webhook requests
+     * @param webhook.notifySchemaChanges - Whether to notify on schema changes
+     * @param webhook.select - Optional field selection (string or array of Column references)
+     * @param webhook.filter - Optional filter (string or FilterExpression)
+     * @returns Promise resolving to the created webhook data with ID
+     * @example
+     * ```ts
+     * const result = await db.webhook.add({
+     *   webhook: "https://example.com/webhook",
+     *   tableName: contactsTable,
+     *   headers: { "X-Custom-Header": "value" },
+     * });
+     * // result.webHookResult.webHookID contains the new webhook ID
+     * ```
+     * @example
+     * ```ts
+     * // Using filter expressions and column arrays (same DX as query builder)
+     * const result = await db.webhook.add({
+     *   webhook: "https://example.com/webhook",
+     *   tableName: contacts,
+     *   filter: eq(contacts.name, "John"),
+     *   select: [contacts.name, contacts.PrimaryKey],
+     * });
+     * ```
+     */
+    add(webhook: Webhook<FMTable>, options?: ExecuteMethodOptions): Promise<WebhookAddResponse>;
+    /**
+     * Deletes a webhook by ID.
+     * @param webhookId - The ID of the webhook to delete
+     * @returns Promise that resolves when the webhook is deleted
+     * @example
+     * ```ts
+     * await db.webhook.remove(1);
+     * ```
+     */
+    remove(webhookId: string | number, options?: ExecuteMethodOptions): Promise<void>;
+    /**
+     * Gets a webhook by ID.
+     * @param webhookId - The ID of the webhook to retrieve
+     * @returns Promise resolving to the webhook data
+     * @example
+     * ```ts
+     * const webhook = await db.webhook.get(1);
+     * // webhook.webHookID, webhook.tableName, webhook.url, etc.
+     * ```
+     */
+    get(webhookId: string | number, options?: ExecuteMethodOptions): Promise<WebhookInfo>;
+    /**
+     * Lists all webhooks.
+     * @returns Promise resolving to webhook list response with status and webhooks array
+     * @example
+     * ```ts
+     * const result = await db.webhook.list();
+     * // result.Status contains the status
+     * // result.WebHook contains the array of webhooks
+     * ```
+     */
+    list(options?: ExecuteMethodOptions): Promise<WebhookListResponse>;
+    /**
+     * Invokes a webhook by ID, optionally for specific row IDs.
+     * @param webhookId - The ID of the webhook to invoke
+     * @param options - Optional configuration
+     * @param options.rowIDs - Array of row IDs to trigger the webhook for
+     * @returns Promise resolving to the invocation result (type unknown until API behavior is confirmed)
+     * @example
+     * ```ts
+     * // Invoke for all rows
+     * await db.webhook.invoke(1);
+     *
+     * // Invoke for specific rows
+     * await db.webhook.invoke(1, { rowIDs: [63, 61] });
+     * ```
+     */
+    invoke(webhookId: string | number, options?: {
+        rowIDs?: number[];
+    }, executeOptions?: ExecuteMethodOptions): Promise<unknown>;
+}

package/dist/esm/client/webhook-builder.js

@@ -0,0 +1,197 @@
+import { isColumn } from "../orm/column.js";
+import { FilterExpression } from "../orm/operators.js";
+import { getTableName } from "../orm/table.js";
+import { formatSelectFields } from "./builders/select-utils.js";
+class WebhookManager {
+  constructor(databaseName, context) {
+    this.databaseName = databaseName;
+    this.context = context;
+  }
+  /**
+   * Adds a new webhook to the database.
+   * @param webhook - The webhook configuration object
+   * @param webhook.webhook - The webhook URL to call
+   * @param webhook.tableName - The FMTable instance for the table to monitor
+   * @param webhook.headers - Optional custom headers to include in webhook requests
+   * @param webhook.notifySchemaChanges - Whether to notify on schema changes
+   * @param webhook.select - Optional field selection (string or array of Column references)
+   * @param webhook.filter - Optional filter (string or FilterExpression)
+   * @returns Promise resolving to the created webhook data with ID
+   * @example
+   * ```ts
+   * const result = await db.webhook.add({
+   *   webhook: "https://example.com/webhook",
+   *   tableName: contactsTable,
+   *   headers: { "X-Custom-Header": "value" },
+   * });
+   * // result.webHookResult.webHookID contains the new webhook ID
+   * ```
+   * @example
+   * ```ts
+   * // Using filter expressions and column arrays (same DX as query builder)
+   * const result = await db.webhook.add({
+   *   webhook: "https://example.com/webhook",
+   *   tableName: contacts,
+   *   filter: eq(contacts.name, "John"),
+   *   select: [contacts.name, contacts.PrimaryKey],
+   * });
+   * ```
+   */
+  async add(webhook, options) {
+    var _a, _b;
+    const tableName = getTableName(webhook.tableName);
+    const useEntityIds = (options == null ? void 0 : options.useEntityIds) ?? ((_b = (_a = this.context)._getUseEntityIds) == null ? void 0 : _b.call(_a)) ?? false;
+    let filter;
+    if (webhook.filter !== void 0) {
+      if (webhook.filter instanceof FilterExpression) {
+        filter = webhook.filter.toODataFilter(useEntityIds);
+      } else {
+        filter = webhook.filter;
+      }
+    }
+    let select;
+    if (webhook.select !== void 0) {
+      if (Array.isArray(webhook.select)) {
+        const fieldNames = webhook.select.map((item) => {
+          if (isColumn(item)) {
+            return item.getFieldIdentifier(useEntityIds);
+          }
+          return String(item);
+        });
+        select = formatSelectFields(
+          fieldNames,
+          webhook.tableName,
+          useEntityIds
+        );
+      } else {
+        select = webhook.select;
+      }
+    }
+    const requestBody = {
+      webhook: webhook.webhook,
+      tableName
+    };
+    if (webhook.headers !== void 0) {
+      requestBody.headers = webhook.headers;
+    }
+    if (webhook.notifySchemaChanges !== void 0) {
+      requestBody.notifySchemaChanges = webhook.notifySchemaChanges;
+    }
+    if (select !== void 0) {
+      requestBody.select = select;
+    }
+    if (filter !== void 0) {
+      requestBody.filter = filter;
+    }
+    const result = await this.context._makeRequest(
+      `/${this.databaseName}/Webhook.Add`,
+      {
+        method: "POST",
+        body: JSON.stringify(requestBody),
+        ...options
+      }
+    );
+    if (result.error) {
+      throw result.error;
+    }
+    return result.data;
+  }
+  /**
+   * Deletes a webhook by ID.
+   * @param webhookId - The ID of the webhook to delete
+   * @returns Promise that resolves when the webhook is deleted
+   * @example
+   * ```ts
+   * await db.webhook.remove(1);
+   * ```
+   */
+  async remove(webhookId, options) {
+    const result = await this.context._makeRequest(
+      `/${this.databaseName}/Webhook.Delete(${webhookId})`,
+      {
+        method: "POST",
+        ...options
+      }
+    );
+    if (result.error) {
+      throw result.error;
+    }
+  }
+  /**
+   * Gets a webhook by ID.
+   * @param webhookId - The ID of the webhook to retrieve
+   * @returns Promise resolving to the webhook data
+   * @example
+   * ```ts
+   * const webhook = await db.webhook.get(1);
+   * // webhook.webHookID, webhook.tableName, webhook.url, etc.
+   * ```
+   */
+  async get(webhookId, options) {
+    const result = await this.context._makeRequest(
+      `/${this.databaseName}/Webhook.Get(${webhookId})`,
+      options
+    );
+    if (result.error) {
+      throw result.error;
+    }
+    return result.data;
+  }
+  /**
+   * Lists all webhooks.
+   * @returns Promise resolving to webhook list response with status and webhooks array
+   * @example
+   * ```ts
+   * const result = await db.webhook.list();
+   * // result.Status contains the status
+   * // result.WebHook contains the array of webhooks
+   * ```
+   */
+  async list(options) {
+    const result = await this.context._makeRequest(
+      `/${this.databaseName}/Webhook.GetAll`,
+      options
+    );
+    if (result.error) {
+      throw result.error;
+    }
+    return result.data;
+  }
+  /**
+   * Invokes a webhook by ID, optionally for specific row IDs.
+   * @param webhookId - The ID of the webhook to invoke
+   * @param options - Optional configuration
+   * @param options.rowIDs - Array of row IDs to trigger the webhook for
+   * @returns Promise resolving to the invocation result (type unknown until API behavior is confirmed)
+   * @example
+   * ```ts
+   * // Invoke for all rows
+   * await db.webhook.invoke(1);
+   *
+   * // Invoke for specific rows
+   * await db.webhook.invoke(1, { rowIDs: [63, 61] });
+   * ```
+   */
+  async invoke(webhookId, options, executeOptions) {
+    const body = {};
+    if ((options == null ? void 0 : options.rowIDs) !== void 0) {
+      body.rowIDs = options.rowIDs;
+    }
+    const result = await this.context._makeRequest(
+      `/${this.databaseName}/Webhook.Invoke(${webhookId})`,
+      {
+        method: "POST",
+        body: Object.keys(body).length > 0 ? JSON.stringify(body) : void 0,
+        ...executeOptions
+      }
+    );
+    if (result.error) {
+      throw result.error;
+    }
+    return result.data;
+  }
+}
+export {
+  WebhookManager
+};
+//# sourceMappingURL=webhook-builder.js.map

package/dist/esm/client/webhook-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook-builder.js","sources":["../../../src/client/webhook-builder.ts"],"sourcesContent":["import { FMTable, getTableName } from \"../orm\";\nimport type { ExecutionContext, ExecuteMethodOptions } from \"../types\";\nimport type { FFetchOptions } from \"@fetchkit/ffetch\";\nimport { FilterExpression } from \"../orm/operators\";\nimport { isColumn, type Column } from \"../orm/column\";\nimport { formatSelectFields } from \"./builders/select-utils\";\n\nexport type Webhook<TableName = string> = {\n  webhook: string;\n  headers?: Record<string, string>;\n  tableName: TableName;\n  notifySchemaChanges?: boolean;\n  select?: string | Column<any, any, any>[];\n  filter?: string | FilterExpression;\n};\n\n/**\n * Webhook information returned by the API\n */\nexport type WebhookInfo = {\n  webHookID: number;\n  tableName: string;\n  url: string;\n  headers?: Record<string, string>;\n  notifySchemaChanges: boolean;\n  select: string;\n  filter: string;\n  pendingOperations: unknown[];\n};\n\n/**\n * Response from listing all webhooks\n */\nexport type WebhookListResponse = {\n  Status: string;\n  WebHook: WebhookInfo[];\n};\n\n/**\n * Response from adding a webhook\n */\nexport type WebhookAddResponse = {\n  webHookResult: {\n    webHookID: number;\n  };\n};\n\nexport class WebhookManager {\n  constructor(\n    private readonly databaseName: string,\n    private readonly context: ExecutionContext,\n  ) {}\n\n  /**\n   * Adds a new webhook to the database.\n   * @param webhook - The webhook configuration object\n   * @param webhook.webhook - The webhook URL to call\n   * @param webhook.tableName - The FMTable instance for the table to monitor\n   * @param webhook.headers - Optional custom headers to include in webhook requests\n   * @param webhook.notifySchemaChanges - Whether to notify on schema changes\n   * @param webhook.select - Optional field selection (string or array of Column references)\n   * @param webhook.filter - Optional filter (string or FilterExpression)\n   * @returns Promise resolving to the created webhook data with ID\n   * @example\n   * ```ts\n   * const result = await db.webhook.add({\n   *   webhook: \"https://example.com/webhook\",\n   *   tableName: contactsTable,\n   *   headers: { \"X-Custom-Header\": \"value\" },\n   * });\n   * // result.webHookResult.webHookID contains the new webhook ID\n   * ```\n   * @example\n   * ```ts\n   * // Using filter expressions and column arrays (same DX as query builder)\n   * const result = await db.webhook.add({\n   *   webhook: \"https://example.com/webhook\",\n   *   tableName: contacts,\n   *   filter: eq(contacts.name, \"John\"),\n   *   select: [contacts.name, contacts.PrimaryKey],\n   * });\n   * ```\n   */\n  async add(\n    webhook: Webhook<FMTable>,\n    options?: ExecuteMethodOptions,\n  ): Promise<WebhookAddResponse> {\n    // Extract the string table name from the FMTable instance\n    const tableName = getTableName(webhook.tableName);\n\n    // Get useEntityIds setting (check options first, then context, default to false)\n    const useEntityIds =\n      options?.useEntityIds ?? this.context._getUseEntityIds?.() ?? false;\n\n    // Transform filter if it's a FilterExpression\n    let filter: string | undefined;\n    if (webhook.filter !== undefined) {\n      if (webhook.filter instanceof FilterExpression) {\n        filter = webhook.filter.toODataFilter(useEntityIds);\n      } else {\n        filter = webhook.filter;\n      }\n    }\n\n    // Transform select if it's an array of Columns\n    let select: string | undefined;\n    if (webhook.select !== undefined) {\n      if (Array.isArray(webhook.select)) {\n        // Extract field identifiers from columns or use strings as-is\n        const fieldNames = webhook.select.map((item) => {\n          if (isColumn(item)) {\n            return item.getFieldIdentifier(useEntityIds);\n          }\n          return String(item);\n        });\n        // Use formatSelectFields to properly format the select string\n        select = formatSelectFields(\n          fieldNames,\n          webhook.tableName,\n          useEntityIds,\n        );\n      } else {\n        // Already a string, use as-is\n        select = webhook.select;\n      }\n    }\n\n    // Create request body with string table name and transformed filter/select\n    const requestBody: {\n      webhook: string;\n      headers?: Record<string, string>;\n      tableName: string;\n      notifySchemaChanges?: boolean;\n      select?: string;\n      filter?: string;\n    } = {\n      webhook: webhook.webhook,\n      tableName,\n    };\n\n    if (webhook.headers !== undefined) {\n      requestBody.headers = webhook.headers;\n    }\n    if (webhook.notifySchemaChanges !== undefined) {\n      requestBody.notifySchemaChanges = webhook.notifySchemaChanges;\n    }\n    if (select !== undefined) {\n      requestBody.select = select;\n    }\n    if (filter !== undefined) {\n      requestBody.filter = filter;\n    }\n\n    const result = await this.context._makeRequest<WebhookAddResponse>(\n      `/${this.databaseName}/Webhook.Add`,\n      {\n        method: \"POST\",\n        body: JSON.stringify(requestBody),\n        ...options,\n      },\n    );\n\n    if (result.error) {\n      throw result.error;\n    }\n\n    return result.data;\n  }\n\n  /**\n   * Deletes a webhook by ID.\n   * @param webhookId - The ID of the webhook to delete\n   * @returns Promise that resolves when the webhook is deleted\n   * @example\n   * ```ts\n   * await db.webhook.remove(1);\n   * ```\n   */\n  async remove(\n    webhookId: string | number,\n    options?: ExecuteMethodOptions,\n  ): Promise<void> {\n    const result = await this.context._makeRequest(\n      `/${this.databaseName}/Webhook.Delete(${webhookId})`,\n      {\n        method: \"POST\",\n        ...options,\n      },\n    );\n\n    if (result.error) {\n      throw result.error;\n    }\n  }\n\n  /**\n   * Gets a webhook by ID.\n   * @param webhookId - The ID of the webhook to retrieve\n   * @returns Promise resolving to the webhook data\n   * @example\n   * ```ts\n   * const webhook = await db.webhook.get(1);\n   * // webhook.webHookID, webhook.tableName, webhook.url, etc.\n   * ```\n   */\n  async get(\n    webhookId: string | number,\n    options?: ExecuteMethodOptions,\n  ): Promise<WebhookInfo> {\n    const result = await this.context._makeRequest<WebhookInfo>(\n      `/${this.databaseName}/Webhook.Get(${webhookId})`,\n      options,\n    );\n\n    if (result.error) {\n      throw result.error;\n    }\n\n    return result.data;\n  }\n\n  /**\n   * Lists all webhooks.\n   * @returns Promise resolving to webhook list response with status and webhooks array\n   * @example\n   * ```ts\n   * const result = await db.webhook.list();\n   * // result.Status contains the status\n   * // result.WebHook contains the array of webhooks\n   * ```\n   */\n  async list(options?: ExecuteMethodOptions): Promise<WebhookListResponse> {\n    const result = await this.context._makeRequest<WebhookListResponse>(\n      `/${this.databaseName}/Webhook.GetAll`,\n      options,\n    );\n\n    if (result.error) {\n      throw result.error;\n    }\n\n    return result.data;\n  }\n\n  /**\n   * Invokes a webhook by ID, optionally for specific row IDs.\n   * @param webhookId - The ID of the webhook to invoke\n   * @param options - Optional configuration\n   * @param options.rowIDs - Array of row IDs to trigger the webhook for\n   * @returns Promise resolving to the invocation result (type unknown until API behavior is confirmed)\n   * @example\n   * ```ts\n   * // Invoke for all rows\n   * await db.webhook.invoke(1);\n   *\n   * // Invoke for specific rows\n   * await db.webhook.invoke(1, { rowIDs: [63, 61] });\n   * ```\n   */\n  async invoke(\n    webhookId: string | number,\n    options?: { rowIDs?: number[] },\n    executeOptions?: ExecuteMethodOptions,\n  ): Promise<unknown> {\n    const body: { rowIDs?: number[] } = {};\n    if (options?.rowIDs !== undefined) {\n      body.rowIDs = options.rowIDs;\n    }\n\n    const result = await this.context._makeRequest<unknown>(\n      `/${this.databaseName}/Webhook.Invoke(${webhookId})`,\n      {\n        method: \"POST\",\n        body: Object.keys(body).length > 0 ? JSON.stringify(body) : undefined,\n        ...executeOptions,\n      },\n    );\n\n    if (result.error) {\n      throw result.error;\n    }\n\n    return result.data;\n  }\n}\n"],"names":[],"mappings":";;;;AA+CO,MAAM,eAAe;AAAA,EAC1B,YACmB,cACA,SACjB;AAFiB,SAAA,eAAA;AACA,SAAA,UAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiCnB,MAAM,IACJ,SACA,SAC6B;;AAEvB,UAAA,YAAY,aAAa,QAAQ,SAAS;AAGhD,UAAM,gBACJ,mCAAS,mBAAgB,gBAAK,SAAQ,qBAAb,gCAAqC;AAG5D,QAAA;AACA,QAAA,QAAQ,WAAW,QAAW;AAC5B,UAAA,QAAQ,kBAAkB,kBAAkB;AACrC,iBAAA,QAAQ,OAAO,cAAc,YAAY;AAAA,MAAA,OAC7C;AACL,iBAAS,QAAQ;AAAA,MAAA;AAAA,IACnB;AAIE,QAAA;AACA,QAAA,QAAQ,WAAW,QAAW;AAChC,UAAI,MAAM,QAAQ,QAAQ,MAAM,GAAG;AAEjC,cAAM,aAAa,QAAQ,OAAO,IAAI,CAAC,SAAS;AAC1C,cAAA,SAAS,IAAI,GAAG;AACX,mBAAA,KAAK,mBAAmB,YAAY;AAAA,UAAA;AAE7C,iBAAO,OAAO,IAAI;AAAA,QAAA,CACnB;AAEQ,iBAAA;AAAA,UACP;AAAA,UACA,QAAQ;AAAA,UACR;AAAA,QACF;AAAA,MAAA,OACK;AAEL,iBAAS,QAAQ;AAAA,MAAA;AAAA,IACnB;AAIF,UAAM,cAOF;AAAA,MACF,SAAS,QAAQ;AAAA,MACjB;AAAA,IACF;AAEI,QAAA,QAAQ,YAAY,QAAW;AACjC,kBAAY,UAAU,QAAQ;AAAA,IAAA;AAE5B,QAAA,QAAQ,wBAAwB,QAAW;AAC7C,kBAAY,sBAAsB,QAAQ;AAAA,IAAA;AAE5C,QAAI,WAAW,QAAW;AACxB,kBAAY,SAAS;AAAA,IAAA;AAEvB,QAAI,WAAW,QAAW;AACxB,kBAAY,SAAS;AAAA,IAAA;AAGjB,UAAA,SAAS,MAAM,KAAK,QAAQ;AAAA,MAChC,IAAI,KAAK,YAAY;AAAA,MACrB;AAAA,QACE,QAAQ;AAAA,QACR,MAAM,KAAK,UAAU,WAAW;AAAA,QAChC,GAAG;AAAA,MAAA;AAAA,IAEP;AAEA,QAAI,OAAO,OAAO;AAChB,YAAM,OAAO;AAAA,IAAA;AAGf,WAAO,OAAO;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYhB,MAAM,OACJ,WACA,SACe;AACT,UAAA,SAAS,MAAM,KAAK,QAAQ;AAAA,MAChC,IAAI,KAAK,YAAY,mBAAmB,SAAS;AAAA,MACjD;AAAA,QACE,QAAQ;AAAA,QACR,GAAG;AAAA,MAAA;AAAA,IAEP;AAEA,QAAI,OAAO,OAAO;AAChB,YAAM,OAAO;AAAA,IAAA;AAAA,EACf;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaF,MAAM,IACJ,WACA,SACsB;AAChB,UAAA,SAAS,MAAM,KAAK,QAAQ;AAAA,MAChC,IAAI,KAAK,YAAY,gBAAgB,SAAS;AAAA,MAC9C;AAAA,IACF;AAEA,QAAI,OAAO,OAAO;AAChB,YAAM,OAAO;AAAA,IAAA;AAGf,WAAO,OAAO;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAahB,MAAM,KAAK,SAA8D;AACjE,UAAA,SAAS,MAAM,KAAK,QAAQ;AAAA,MAChC,IAAI,KAAK,YAAY;AAAA,MACrB;AAAA,IACF;AAEA,QAAI,OAAO,OAAO;AAChB,YAAM,OAAO;AAAA,IAAA;AAGf,WAAO,OAAO;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBhB,MAAM,OACJ,WACA,SACA,gBACkB;AAClB,UAAM,OAA8B,CAAC;AACjC,SAAA,mCAAS,YAAW,QAAW;AACjC,WAAK,SAAS,QAAQ;AAAA,IAAA;AAGlB,UAAA,SAAS,MAAM,KAAK,QAAQ;AAAA,MAChC,IAAI,KAAK,YAAY,mBAAmB,SAAS;AAAA,MACjD;AAAA,QACE,QAAQ;AAAA,QACR,MAAM,OAAO,KAAK,IAAI,EAAE,SAAS,IAAI,KAAK,UAAU,IAAI,IAAI;AAAA,QAC5D,GAAG;AAAA,MAAA;AAAA,IAEP;AAEA,QAAI,OAAO,OAAO;AAChB,YAAM,OAAO;AAAA,IAAA;AAGf,WAAO,OAAO;AAAA,EAAA;AAElB;"}

package/dist/esm/index.d.ts

@@ -3,6 +3,7 @@ export { textField, numberField, dateField, timeField, timestampField, container
 export type { Database } from './client/database.js';
 export type { EntitySet } from './client/entity-set.js';
 export type { SchemaManager, Field, StringField, NumericField, DateField, TimeField, TimestampField, ContainerField, } from './client/schema-manager.js';
+export type { Webhook, WebhookInfo, WebhookListResponse, WebhookAddResponse, } from './client/webhook-builder.js';
 export type { Result, BatchResult, BatchItemResult, InferSchemaType, ODataRecordMetadata, Metadata, FetchHandler, ExecuteMethodOptions, ExecuteOptions, } from './types.js';
 export { TimeoutError, AbortError, NetworkError, RetryLimitError, CircuitOpenError, } from '@fetchkit/ffetch';
 export type { FFetchOptions } from '@fetchkit/ffetch';

package/dist/esm/orm/field-builders.d.ts

@@ -24,12 +24,13 @@ export declare class FieldBuilder<TOutput = any, TInput = TOutput, TDbType = TOu
     private _outputValidator?;
     private _inputValidator?;
     private _fieldType;
+    private _comment?;
     constructor(fieldType: string);
     /**
      * Mark this field as the primary key for the table.
-     * Primary keys are automatically read-only.
+     * Primary keys are automatically read-only and non-nullable.
      */
-    primaryKey(): FieldBuilder<TOutput, TInput, TDbType, true>;
+    primaryKey(): FieldBuilder<NonNullable<TOutput>, NonNullable<TInput>, NonNullable<TDbType>, true>;
     /**
      * Mark this field as non-nullable.
      * Updates the type to exclude null/undefined.
@@ -63,6 +64,14 @@ export declare class FieldBuilder<TOutput = any, TInput = TOutput, TDbType = TOu
      * // You pass true/false, FileMaker gets 1/0
      */
     writeValidator<I>(validator: StandardSchemaV1<I, TDbType>): FieldBuilder<TOutput, I, TDbType, TReadOnly>;
+    /**
+     * Add a comment to this field for metadata purposes.
+     * This helps future developers understand the purpose of the field.
+     *
+     * @example
+     * textField().comment("Account name of the user who last modified each record")
+     */
+    comment(comment: string): FieldBuilder<TOutput, TInput, TDbType, TReadOnly>;
     /**
      * Get the metadata configuration for this field.
      * @internal Used by fmTableOccurrence to extract field configuration
@@ -75,6 +84,7 @@ export declare class FieldBuilder<TOutput = any, TInput = TOutput, TDbType = TOu
         entityId: `FMFID:${string}` | undefined;
         outputValidator: StandardSchemaV1<any, TOutput> | undefined;
         inputValidator: StandardSchemaV1<TInput, any> | undefined;
+        comment: string | undefined;
     };
     /**
      * Clone this builder to allow immutable chaining.

package/dist/esm/orm/field-builders.js

@@ -10,15 +10,17 @@ class FieldBuilder {
     __publicField(this, "_outputValidator");
     __publicField(this, "_inputValidator");
     __publicField(this, "_fieldType");
+    __publicField(this, "_comment");
     this._fieldType = fieldType;
   }
   /**
    * Mark this field as the primary key for the table.
-   * Primary keys are automatically read-only.
+   * Primary keys are automatically read-only and non-nullable.
    */
   primaryKey() {
     const builder = this._clone();
     builder._primaryKey = true;
+    builder._notNull = true;
     builder._readOnly = true;
     return builder;
   }
@@ -75,6 +77,18 @@ class FieldBuilder {
     builder._inputValidator = validator;
     return builder;
   }
+  /**
+   * Add a comment to this field for metadata purposes.
+   * This helps future developers understand the purpose of the field.
+   *
+   * @example
+   * textField().comment("Account name of the user who last modified each record")
+   */
+  comment(comment) {
+    const builder = this._clone();
+    builder._comment = comment;
+    return builder;
+  }
   /**
    * Get the metadata configuration for this field.
    * @internal Used by fmTableOccurrence to extract field configuration
@@ -87,7 +101,8 @@ class FieldBuilder {
       readOnly: this._readOnly,
       entityId: this._entityId,
       outputValidator: this._outputValidator,
-      inputValidator: this._inputValidator
+      inputValidator: this._inputValidator,
+      comment: this._comment
     };
   }
   /**
@@ -104,6 +119,7 @@ class FieldBuilder {
     builder._entityId = this._entityId;
     builder._outputValidator = this._outputValidator;
     builder._inputValidator = this._inputValidator;
+    builder._comment = this._comment;
     return builder;
   }
 }

package/dist/esm/orm/field-builders.js.map

@@ -1 +1 @@
-{"version":3,"file":"field-builders.js","sources":["../../../src/orm/field-builders.ts"],"sourcesContent":["import type { StandardSchemaV1 } from \"@standard-schema/spec\";\n\n/**\n * Branded type for container field's database type.\n * This allows TypeScript to distinguish container fields from regular string fields\n * at the type level, enabling compile-time exclusion from select operations.\n */\nexport type ContainerDbType = string & { readonly __container: true };\n\n/**\n * FieldBuilder provides a fluent API for defining table fields with type-safe metadata.\n * Supports chaining methods to configure primary keys, nullability, read-only status, entity IDs, and validators.\n *\n * @template TOutput - The output type after applying outputValidator (what you get when reading)\n * @template TInput - The input type after applying inputValidator (what you pass when writing)\n * @template TDbType - The database type (what FileMaker stores/expects)\n * @template TReadOnly - Whether this field is read-only (for type-level exclusion from insert/update)\n */\nexport class FieldBuilder<\n  TOutput = any,\n  TInput = TOutput,\n  TDbType = TOutput,\n  TReadOnly extends boolean = false,\n> {\n  private _primaryKey = false;\n  private _notNull = false;\n  private _readOnly = false;\n  private _entityId?: `FMFID:${string}`;\n  private _outputValidator?: StandardSchemaV1<any, TOutput>;\n  private _inputValidator?: StandardSchemaV1<TInput, any>;\n  private _fieldType: string;\n\n  constructor(fieldType: string) {\n    this._fieldType = fieldType;\n  }\n\n  /**\n   * Mark this field as the primary key for the table.\n   * Primary keys are automatically read-only.\n   */\n  primaryKey(): FieldBuilder<TOutput, TInput, TDbType, true> {\n    const builder = this._clone() as any;\n    builder._primaryKey = true;\n    builder._readOnly = true; // Primary keys are automatically read-only\n    return builder;\n  }\n\n  /**\n   * Mark this field as non-nullable.\n   * Updates the type to exclude null/undefined.\n   */\n  notNull(): FieldBuilder<\n    NonNullable<TOutput>,\n    NonNullable<TInput>,\n    NonNullable<TDbType>,\n    TReadOnly\n  > {\n    const builder = this._clone() as any;\n    builder._notNull = true;\n    return builder;\n  }\n\n  /**\n   * Mark this field as read-only.\n   * Read-only fields are excluded from insert and update operations.\n   */\n  readOnly(): FieldBuilder<TOutput, TInput, TDbType, true> {\n    const builder = this._clone() as any;\n    builder._readOnly = true;\n    return builder;\n  }\n\n  /**\n   * Assign a FileMaker field ID (FMFID) to this field.\n   * When useEntityIds is enabled, this ID will be used in API requests instead of the field name.\n   */\n  entityId(\n    id: `FMFID:${string}`,\n  ): FieldBuilder<TOutput, TInput, TDbType, TReadOnly> {\n    const builder = this._clone();\n    builder._entityId = id;\n    return builder;\n  }\n\n  /**\n   * Set a validator for the output (reading from database).\n   * The output validator transforms/validates data coming FROM the database in list or get operations.\n   *\n   * @example\n   * numberField().readValidator(z.coerce.boolean())\n   * // FileMaker returns 0/1, you get true/false\n   */\n  readValidator<O, VInput = TDbType>(\n    validator: StandardSchemaV1<VInput, O>,\n  ): FieldBuilder<O, TInput, TDbType, TReadOnly> {\n    const builder = this._clone() as any;\n    builder._outputValidator = validator;\n    return builder;\n  }\n\n  /**\n   * Set a validator for the input (writing to database).\n   * The input validator transforms/validates data going TO the database in insert, update, and filter operations.\n   *\n   * @example\n   * numberField().writeValidator(z.boolean().transform(v => v ? 1 : 0))\n   * // You pass true/false, FileMaker gets 1/0\n   */\n  writeValidator<I>(\n    validator: StandardSchemaV1<I, TDbType>,\n  ): FieldBuilder<TOutput, I, TDbType, TReadOnly> {\n    const builder = this._clone() as any;\n    builder._inputValidator = validator;\n    return builder;\n  }\n\n  /**\n   * Get the metadata configuration for this field.\n   * @internal Used by fmTableOccurrence to extract field configuration\n   */\n  _getConfig() {\n    return {\n      fieldType: this._fieldType,\n      primaryKey: this._primaryKey,\n      notNull: this._notNull,\n      readOnly: this._readOnly,\n      entityId: this._entityId,\n      outputValidator: this._outputValidator,\n      inputValidator: this._inputValidator,\n    };\n  }\n\n  /**\n   * Clone this builder to allow immutable chaining.\n   * @private\n   */\n  private _clone(): FieldBuilder<TOutput, TInput, TDbType, TReadOnly> {\n    const builder = new FieldBuilder<TOutput, TInput, TDbType, TReadOnly>(\n      this._fieldType,\n    );\n    builder._primaryKey = this._primaryKey;\n    builder._notNull = this._notNull;\n    builder._readOnly = this._readOnly;\n    builder._entityId = this._entityId;\n    builder._outputValidator = this._outputValidator;\n    builder._inputValidator = this._inputValidator;\n    return builder;\n  }\n}\n\n/**\n * Create a text field (Edm.String in FileMaker OData).\n * By default, text fields are nullable.\n *\n * @example\n * textField()                    // string | null\n * textField().notNull()          // string\n * textField().entityId(\"FMFID:1\") // with entity ID\n */\nexport function textField(): FieldBuilder<\n  string | null,\n  string | null,\n  string | null,\n  false\n> {\n  return new FieldBuilder<string | null, string | null, string | null, false>(\n    \"text\",\n  );\n}\n\n/**\n * Create a number field (Edm.Decimal in FileMaker OData).\n * By default, number fields are nullable.\n *\n * @example\n * numberField()                   // number | null\n * numberField().notNull()         // number\n * numberField().outputValidator(z.coerce.boolean()) // transform to boolean on read\n */\nexport function numberField(): FieldBuilder<\n  number | null,\n  number | null,\n  number | null,\n  false\n> {\n  return new FieldBuilder<number | null, number | null, number | null, false>(\n    \"number\",\n  );\n}\n\n/**\n * Create a date field (Edm.Date in FileMaker OData).\n * By default, date fields are nullable and represented as ISO date strings (YYYY-MM-DD).\n *\n * @example\n * dateField()         // string | null (ISO date format)\n * dateField().notNull() // string\n */\nexport function dateField(): FieldBuilder<\n  string | null,\n  string | null,\n  string | null,\n  false\n> {\n  return new FieldBuilder<string | null, string | null, string | null, false>(\n    \"date\",\n  );\n}\n\n/**\n * Create a time field (Edm.TimeOfDay in FileMaker OData).\n * By default, time fields are nullable and represented as ISO time strings (HH:mm:ss).\n *\n * @example\n * timeField()         // string | null (ISO time format)\n * timeField().notNull() // string\n */\nexport function timeField(): FieldBuilder<\n  string | null,\n  string | null,\n  string | null,\n  false\n> {\n  return new FieldBuilder<string | null, string | null, string | null, false>(\n    \"time\",\n  );\n}\n\n/**\n * Create a timestamp field (Edm.DateTimeOffset in FileMaker OData).\n * By default, timestamp fields are nullable and represented as ISO 8601 strings.\n *\n * @example\n * timestampField()         // string | null (ISO 8601 format)\n * timestampField().notNull() // string\n * timestampField().readOnly() // typical for CreationTimestamp\n */\nexport function timestampField(): FieldBuilder<\n  string | null,\n  string | null,\n  string | null,\n  false\n> {\n  return new FieldBuilder<string | null, string | null, string | null, false>(\n    \"timestamp\",\n  );\n}\n\n/**\n * Create a container field (Edm.Stream in FileMaker OData).\n * Container fields store binary data and are represented as base64 strings in the API.\n * By default, container fields are nullable.\n *\n * Note: Container fields cannot be selected via .select() - they can only be accessed\n * via .getSingleField() due to FileMaker OData API limitations.\n *\n * @example\n * containerField()         // string | null (base64 encoded)\n * containerField().notNull() // string\n */\nexport function containerField(): FieldBuilder<\n  string | null,\n  string | null,\n  ContainerDbType | null,\n  false\n> {\n  return new FieldBuilder<\n    string | null,\n    string | null,\n    ContainerDbType | null,\n    false\n  >(\"container\");\n}\n\n/**\n * Create a calculated field (read-only field computed by FileMaker).\n * Calculated fields are automatically marked as read-only.\n *\n * @example\n * calcField()         // string | null\n * calcField().notNull() // string\n */\nexport function calcField(): FieldBuilder<\n  string | null,\n  string | null,\n  string | null,\n  true\n> {\n  const builder = new FieldBuilder<\n    string | null,\n    string | null,\n    string | null,\n    false\n  >(\"calculated\");\n  return builder.readOnly();\n}\n"],"names":[],"mappings":";;;AAkBO,MAAM,aAKX;AAAA,EASA,YAAY,WAAmB;AARvB,uCAAc;AACd,oCAAW;AACX,qCAAY;AACZ;AACA;AACA;AACA;AAGN,SAAK,aAAa;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOpB,aAA2D;AACnD,UAAA,UAAU,KAAK,OAAO;AAC5B,YAAQ,cAAc;AACtB,YAAQ,YAAY;AACb,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOT,UAKE;AACM,UAAA,UAAU,KAAK,OAAO;AAC5B,YAAQ,WAAW;AACZ,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOT,WAAyD;AACjD,UAAA,UAAU,KAAK,OAAO;AAC5B,YAAQ,YAAY;AACb,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOT,SACE,IACmD;AAC7C,UAAA,UAAU,KAAK,OAAO;AAC5B,YAAQ,YAAY;AACb,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWT,cACE,WAC6C;AACvC,UAAA,UAAU,KAAK,OAAO;AAC5B,YAAQ,mBAAmB;AACpB,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWT,eACE,WAC8C;AACxC,UAAA,UAAU,KAAK,OAAO;AAC5B,YAAQ,kBAAkB;AACnB,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOT,aAAa;AACJ,WAAA;AAAA,MACL,WAAW,KAAK;AAAA,MAChB,YAAY,KAAK;AAAA,MACjB,SAAS,KAAK;AAAA,MACd,UAAU,KAAK;AAAA,MACf,UAAU,KAAK;AAAA,MACf,iBAAiB,KAAK;AAAA,MACtB,gBAAgB,KAAK;AAAA,IACvB;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOM,SAA4D;AAClE,UAAM,UAAU,IAAI;AAAA,MAClB,KAAK;AAAA,IACP;AACA,YAAQ,cAAc,KAAK;AAC3B,YAAQ,WAAW,KAAK;AACxB,YAAQ,YAAY,KAAK;AACzB,YAAQ,YAAY,KAAK;AACzB,YAAQ,mBAAmB,KAAK;AAChC,YAAQ,kBAAkB,KAAK;AACxB,WAAA;AAAA,EAAA;AAEX;AAWO,SAAS,YAKd;AACA,SAAO,IAAI;AAAA,IACT;AAAA,EACF;AACF;AAWO,SAAS,cAKd;AACA,SAAO,IAAI;AAAA,IACT;AAAA,EACF;AACF;AAUO,SAAS,YAKd;AACA,SAAO,IAAI;AAAA,IACT;AAAA,EACF;AACF;AAUO,SAAS,YAKd;AACA,SAAO,IAAI;AAAA,IACT;AAAA,EACF;AACF;AAWO,SAAS,iBAKd;AACA,SAAO,IAAI;AAAA,IACT;AAAA,EACF;AACF;AAcO,SAAS,iBAKd;AACO,SAAA,IAAI,aAKT,WAAW;AACf;AAUO,SAAS,YAKd;AACM,QAAA,UAAU,IAAI,aAKlB,YAAY;AACd,SAAO,QAAQ,SAAS;AAC1B;"}
+{"version":3,"file":"field-builders.js","sources":["../../../src/orm/field-builders.ts"],"sourcesContent":["import type { StandardSchemaV1 } from \"@standard-schema/spec\";\n\n/**\n * Branded type for container field's database type.\n * This allows TypeScript to distinguish container fields from regular string fields\n * at the type level, enabling compile-time exclusion from select operations.\n */\nexport type ContainerDbType = string & { readonly __container: true };\n\n/**\n * FieldBuilder provides a fluent API for defining table fields with type-safe metadata.\n * Supports chaining methods to configure primary keys, nullability, read-only status, entity IDs, and validators.\n *\n * @template TOutput - The output type after applying outputValidator (what you get when reading)\n * @template TInput - The input type after applying inputValidator (what you pass when writing)\n * @template TDbType - The database type (what FileMaker stores/expects)\n * @template TReadOnly - Whether this field is read-only (for type-level exclusion from insert/update)\n */\nexport class FieldBuilder<\n  TOutput = any,\n  TInput = TOutput,\n  TDbType = TOutput,\n  TReadOnly extends boolean = false,\n> {\n  private _primaryKey = false;\n  private _notNull = false;\n  private _readOnly = false;\n  private _entityId?: `FMFID:${string}`;\n  private _outputValidator?: StandardSchemaV1<any, TOutput>;\n  private _inputValidator?: StandardSchemaV1<TInput, any>;\n  private _fieldType: string;\n  private _comment?: string;\n\n  constructor(fieldType: string) {\n    this._fieldType = fieldType;\n  }\n\n  /**\n   * Mark this field as the primary key for the table.\n   * Primary keys are automatically read-only and non-nullable.\n   */\n  primaryKey(): FieldBuilder<\n    NonNullable<TOutput>,\n    NonNullable<TInput>,\n    NonNullable<TDbType>,\n    true\n  > {\n    const builder = this._clone() as any;\n    builder._primaryKey = true;\n    builder._notNull = true; // Primary keys are automatically non-nullable\n    builder._readOnly = true; // Primary keys are automatically read-only\n    return builder;\n  }\n\n  /**\n   * Mark this field as non-nullable.\n   * Updates the type to exclude null/undefined.\n   */\n  notNull(): FieldBuilder<\n    NonNullable<TOutput>,\n    NonNullable<TInput>,\n    NonNullable<TDbType>,\n    TReadOnly\n  > {\n    const builder = this._clone() as any;\n    builder._notNull = true;\n    return builder;\n  }\n\n  /**\n   * Mark this field as read-only.\n   * Read-only fields are excluded from insert and update operations.\n   */\n  readOnly(): FieldBuilder<TOutput, TInput, TDbType, true> {\n    const builder = this._clone() as any;\n    builder._readOnly = true;\n    return builder;\n  }\n\n  /**\n   * Assign a FileMaker field ID (FMFID) to this field.\n   * When useEntityIds is enabled, this ID will be used in API requests instead of the field name.\n   */\n  entityId(\n    id: `FMFID:${string}`,\n  ): FieldBuilder<TOutput, TInput, TDbType, TReadOnly> {\n    const builder = this._clone();\n    builder._entityId = id;\n    return builder;\n  }\n\n  /**\n   * Set a validator for the output (reading from database).\n   * The output validator transforms/validates data coming FROM the database in list or get operations.\n   *\n   * @example\n   * numberField().readValidator(z.coerce.boolean())\n   * // FileMaker returns 0/1, you get true/false\n   */\n  readValidator<O, VInput = TDbType>(\n    validator: StandardSchemaV1<VInput, O>,\n  ): FieldBuilder<O, TInput, TDbType, TReadOnly> {\n    const builder = this._clone() as any;\n    builder._outputValidator = validator;\n    return builder;\n  }\n\n  /**\n   * Set a validator for the input (writing to database).\n   * The input validator transforms/validates data going TO the database in insert, update, and filter operations.\n   *\n   * @example\n   * numberField().writeValidator(z.boolean().transform(v => v ? 1 : 0))\n   * // You pass true/false, FileMaker gets 1/0\n   */\n  writeValidator<I>(\n    validator: StandardSchemaV1<I, TDbType>,\n  ): FieldBuilder<TOutput, I, TDbType, TReadOnly> {\n    const builder = this._clone() as any;\n    builder._inputValidator = validator;\n    return builder;\n  }\n\n  /**\n   * Add a comment to this field for metadata purposes.\n   * This helps future developers understand the purpose of the field.\n   *\n   * @example\n   * textField().comment(\"Account name of the user who last modified each record\")\n   */\n  comment(comment: string): FieldBuilder<TOutput, TInput, TDbType, TReadOnly> {\n    const builder = this._clone();\n    builder._comment = comment;\n    return builder;\n  }\n\n  /**\n   * Get the metadata configuration for this field.\n   * @internal Used by fmTableOccurrence to extract field configuration\n   */\n  _getConfig() {\n    return {\n      fieldType: this._fieldType,\n      primaryKey: this._primaryKey,\n      notNull: this._notNull,\n      readOnly: this._readOnly,\n      entityId: this._entityId,\n      outputValidator: this._outputValidator,\n      inputValidator: this._inputValidator,\n      comment: this._comment,\n    };\n  }\n\n  /**\n   * Clone this builder to allow immutable chaining.\n   * @private\n   */\n  private _clone(): FieldBuilder<TOutput, TInput, TDbType, TReadOnly> {\n    const builder = new FieldBuilder<TOutput, TInput, TDbType, TReadOnly>(\n      this._fieldType,\n    );\n    builder._primaryKey = this._primaryKey;\n    builder._notNull = this._notNull;\n    builder._readOnly = this._readOnly;\n    builder._entityId = this._entityId;\n    builder._outputValidator = this._outputValidator;\n    builder._inputValidator = this._inputValidator;\n    builder._comment = this._comment;\n    return builder;\n  }\n}\n\n/**\n * Create a text field (Edm.String in FileMaker OData).\n * By default, text fields are nullable.\n *\n * @example\n * textField()                    // string | null\n * textField().notNull()          // string\n * textField().entityId(\"FMFID:1\") // with entity ID\n */\nexport function textField(): FieldBuilder<\n  string | null,\n  string | null,\n  string | null,\n  false\n> {\n  return new FieldBuilder<string | null, string | null, string | null, false>(\n    \"text\",\n  );\n}\n\n/**\n * Create a number field (Edm.Decimal in FileMaker OData).\n * By default, number fields are nullable.\n *\n * @example\n * numberField()                   // number | null\n * numberField().notNull()         // number\n * numberField().outputValidator(z.coerce.boolean()) // transform to boolean on read\n */\nexport function numberField(): FieldBuilder<\n  number | null,\n  number | null,\n  number | null,\n  false\n> {\n  return new FieldBuilder<number | null, number | null, number | null, false>(\n    \"number\",\n  );\n}\n\n/**\n * Create a date field (Edm.Date in FileMaker OData).\n * By default, date fields are nullable and represented as ISO date strings (YYYY-MM-DD).\n *\n * @example\n * dateField()         // string | null (ISO date format)\n * dateField().notNull() // string\n */\nexport function dateField(): FieldBuilder<\n  string | null,\n  string | null,\n  string | null,\n  false\n> {\n  return new FieldBuilder<string | null, string | null, string | null, false>(\n    \"date\",\n  );\n}\n\n/**\n * Create a time field (Edm.TimeOfDay in FileMaker OData).\n * By default, time fields are nullable and represented as ISO time strings (HH:mm:ss).\n *\n * @example\n * timeField()         // string | null (ISO time format)\n * timeField().notNull() // string\n */\nexport function timeField(): FieldBuilder<\n  string | null,\n  string | null,\n  string | null,\n  false\n> {\n  return new FieldBuilder<string | null, string | null, string | null, false>(\n    \"time\",\n  );\n}\n\n/**\n * Create a timestamp field (Edm.DateTimeOffset in FileMaker OData).\n * By default, timestamp fields are nullable and represented as ISO 8601 strings.\n *\n * @example\n * timestampField()         // string | null (ISO 8601 format)\n * timestampField().notNull() // string\n * timestampField().readOnly() // typical for CreationTimestamp\n */\nexport function timestampField(): FieldBuilder<\n  string | null,\n  string | null,\n  string | null,\n  false\n> {\n  return new FieldBuilder<string | null, string | null, string | null, false>(\n    \"timestamp\",\n  );\n}\n\n/**\n * Create a container field (Edm.Stream in FileMaker OData).\n * Container fields store binary data and are represented as base64 strings in the API.\n * By default, container fields are nullable.\n *\n * Note: Container fields cannot be selected via .select() - they can only be accessed\n * via .getSingleField() due to FileMaker OData API limitations.\n *\n * @example\n * containerField()         // string | null (base64 encoded)\n * containerField().notNull() // string\n */\nexport function containerField(): FieldBuilder<\n  string | null,\n  string | null,\n  ContainerDbType | null,\n  false\n> {\n  return new FieldBuilder<\n    string | null,\n    string | null,\n    ContainerDbType | null,\n    false\n  >(\"container\");\n}\n\n/**\n * Create a calculated field (read-only field computed by FileMaker).\n * Calculated fields are automatically marked as read-only.\n *\n * @example\n * calcField()         // string | null\n * calcField().notNull() // string\n */\nexport function calcField(): FieldBuilder<\n  string | null,\n  string | null,\n  string | null,\n  true\n> {\n  const builder = new FieldBuilder<\n    string | null,\n    string | null,\n    string | null,\n    false\n  >(\"calculated\");\n  return builder.readOnly();\n}\n"],"names":[],"mappings":";;;AAkBO,MAAM,aAKX;AAAA,EAUA,YAAY,WAAmB;AATvB,uCAAc;AACd,oCAAW;AACX,qCAAY;AACZ;AACA;AACA;AACA;AACA;AAGN,SAAK,aAAa;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOpB,aAKE;AACM,UAAA,UAAU,KAAK,OAAO;AAC5B,YAAQ,cAAc;AACtB,YAAQ,WAAW;AACnB,YAAQ,YAAY;AACb,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOT,UAKE;AACM,UAAA,UAAU,KAAK,OAAO;AAC5B,YAAQ,WAAW;AACZ,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOT,WAAyD;AACjD,UAAA,UAAU,KAAK,OAAO;AAC5B,YAAQ,YAAY;AACb,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOT,SACE,IACmD;AAC7C,UAAA,UAAU,KAAK,OAAO;AAC5B,YAAQ,YAAY;AACb,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWT,cACE,WAC6C;AACvC,UAAA,UAAU,KAAK,OAAO;AAC5B,YAAQ,mBAAmB;AACpB,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWT,eACE,WAC8C;AACxC,UAAA,UAAU,KAAK,OAAO;AAC5B,YAAQ,kBAAkB;AACnB,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUT,QAAQ,SAAoE;AACpE,UAAA,UAAU,KAAK,OAAO;AAC5B,YAAQ,WAAW;AACZ,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOT,aAAa;AACJ,WAAA;AAAA,MACL,WAAW,KAAK;AAAA,MAChB,YAAY,KAAK;AAAA,MACjB,SAAS,KAAK;AAAA,MACd,UAAU,KAAK;AAAA,MACf,UAAU,KAAK;AAAA,MACf,iBAAiB,KAAK;AAAA,MACtB,gBAAgB,KAAK;AAAA,MACrB,SAAS,KAAK;AAAA,IAChB;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOM,SAA4D;AAClE,UAAM,UAAU,IAAI;AAAA,MAClB,KAAK;AAAA,IACP;AACA,YAAQ,cAAc,KAAK;AAC3B,YAAQ,WAAW,KAAK;AACxB,YAAQ,YAAY,KAAK;AACzB,YAAQ,YAAY,KAAK;AACzB,YAAQ,mBAAmB,KAAK;AAChC,YAAQ,kBAAkB,KAAK;AAC/B,YAAQ,WAAW,KAAK;AACjB,WAAA;AAAA,EAAA;AAEX;AAWO,SAAS,YAKd;AACA,SAAO,IAAI;AAAA,IACT;AAAA,EACF;AACF;AAWO,SAAS,cAKd;AACA,SAAO,IAAI;AAAA,IACT;AAAA,EACF;AACF;AAUO,SAAS,YAKd;AACA,SAAO,IAAI;AAAA,IACT;AAAA,EACF;AACF;AAUO,SAAS,YAKd;AACA,SAAO,IAAI;AAAA,IACT;AAAA,EACF;AACF;AAWO,SAAS,iBAKd;AACA,SAAO,IAAI;AAAA,IACT;AAAA,EACF;AACF;AAcO,SAAS,iBAKd;AACO,SAAA,IAAI,aAKT,WAAW;AACf;AAUO,SAAS,YAKd;AACM,QAAA,UAAU,IAAI,aAKlB,YAAY;AACd,SAAO,QAAQ,SAAS;AAC1B;"}

package/dist/esm/orm/table.d.ts

@@ -56,6 +56,7 @@ declare const FMTableNavigationPaths: unique symbol;
 declare const FMTableDefaultSelect: unique symbol;
 declare const FMTableBaseTableConfig: unique symbol;
 declare const FMTableUseEntityIds: unique symbol;
+declare const FMTableComment: unique symbol;
 /**
  * Base table class with Symbol-based internal properties.
  * This follows the Drizzle ORM pattern where internal configuration
@@ -75,6 +76,7 @@ export declare class FMTable<TFields extends Record<string, FieldBuilder<any, an
         NavigationPaths: symbol;
         DefaultSelect: symbol;
         BaseTableConfig: symbol;
+        Comment: symbol;
     };
     /** @internal */
     [FMTableName]: TName;
@@ -83,7 +85,9 @@ export declare class FMTable<TFields extends Record<string, FieldBuilder<any, an
     /** @internal */
     [FMTableUseEntityIds]?: boolean;
     /** @internal */
-    [FMTableSchema]: StandardSchemaV1<any, InferSchemaFromFields<TFields>>;
+    [FMTableComment]?: string;
+    /** @internal */
+    [FMTableSchema]: Partial<Record<keyof TFields, StandardSchemaV1>>;
     /** @internal */
     [FMTableFields]: TFields;
     /** @internal */
@@ -92,8 +96,8 @@ export declare class FMTable<TFields extends Record<string, FieldBuilder<any, an
     [FMTableDefaultSelect]: "all" | "schema" | Record<string, Column<any, any, TName>>;
     /** @internal */
     [FMTableBaseTableConfig]: {
-        schema: Record<keyof TFields, StandardSchemaV1>;
-        inputSchema?: Record<keyof TFields, StandardSchemaV1>;
+        schema: Partial<Record<keyof TFields, StandardSchemaV1>>;
+        inputSchema?: Partial<Record<keyof TFields, StandardSchemaV1>>;
         idField?: keyof TFields;
         required: readonly (keyof TFields)[];
         readOnly: readonly (keyof TFields)[];
@@ -104,13 +108,14 @@ export declare class FMTable<TFields extends Record<string, FieldBuilder<any, an
         name: TName;
         entityId?: `FMTID:${string}`;
         useEntityIds?: boolean;
-        schema: StandardSchemaV1<any, InferSchemaFromFields<TFields>>;
+        comment?: string;
+        schema: Partial<Record<keyof TFields, StandardSchemaV1>>;
         fields: TFields;
         navigationPaths: TNavigationPaths;
         defaultSelect: "all" | "schema" | Record<string, Column<any, any, TName>>;
         baseTableConfig: {
-            schema: Record<keyof TFields, StandardSchemaV1>;
-            inputSchema?: Record<keyof TFields, StandardSchemaV1>;
+            schema: Partial<Record<keyof TFields, StandardSchemaV1>>;
+            inputSchema?: Partial<Record<keyof TFields, StandardSchemaV1>>;
             idField?: keyof TFields;
             required: readonly (keyof TFields)[];
             readOnly: readonly (keyof TFields)[];
@@ -157,6 +162,8 @@ export type FMTableWithColumns<TFields extends Record<string, FieldBuilder<any,
 export interface FMTableOccurrenceOptions<TFields extends Record<string, FieldBuilder<any, any, any, any>>, TName extends string> {
     /** The entity ID (FMTID) for this table occurrence */
     entityId?: `FMTID:${string}`;
+    /** The comment for this table */
+    comment?: string;
     /**
      * Default select behavior:
      * - "all": Select all fields (including related tables)
@@ -264,9 +271,9 @@ export declare function getTableEntityId<T extends FMTable<any, any>>(table: T):
 /**
  * Get the schema validator from an FMTable instance.
  * @param table - FMTable instance
- * @returns The StandardSchemaV1 validator
+ * @returns The StandardSchemaV1 validator record (partial - only fields with validators)
  */
-export declare function getTableSchema<T extends FMTable<any, any>>(table: T): StandardSchemaV1;
+export declare function getTableSchema<T extends FMTable<any, any>>(table: T): Partial<Record<keyof T[typeof FMTableFields], StandardSchemaV1>>;
 /**
  * Get the fields from an FMTable instance.
  * @param table - FMTable instance
@@ -292,8 +299,8 @@ export declare function getDefaultSelect<T extends FMTable<any, any>>(table: T):
  * @returns Base table configuration object
  */
 export declare function getBaseTableConfig<T extends FMTable<any, any>>(table: T): {
-    schema: Record<string | number | symbol, StandardSchemaV1<unknown, unknown>>;
-    inputSchema?: Record<string | number | symbol, StandardSchemaV1<unknown, unknown>> | undefined;
+    schema: Partial<Record<string | number | symbol, StandardSchemaV1<unknown, unknown>>>;
+    inputSchema?: Partial<Record<string | number | symbol, StandardSchemaV1<unknown, unknown>>> | undefined;
     idField?: string | number | symbol | undefined;
     required: readonly (string | number | symbol)[];
     readOnly: readonly (string | number | symbol)[];
@@ -327,6 +334,12 @@ export declare function getFieldName<T extends FMTable<any, any>>(table: T, fiel
  * @returns The FMTID string or the table name
  */
 export declare function getTableId<T extends FMTable<any, any>>(table: T): string;
+/**
+ * Get the comment from an FMTable instance.
+ * @param table - FMTable instance
+ * @returns The comment string or undefined if not set
+ */
+export declare function getTableComment<T extends FMTable<any, any>>(table: T): string | undefined;
 /**
  * Get all columns from a table as an object.
  * Useful for selecting all fields except some using destructuring.