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

package/src/client/record-builder.ts

@@ -19,7 +19,7 @@ import { StandardSchemaV1 } from "@standard-schema/spec";
 // Helper type to extract schema from a TableOccurrence
 type ExtractSchemaFromOccurrence<O> =
   O extends TableOccurrence<infer BT, any, any, any>
-    ? BT extends BaseTable<infer S, any>
+    ? BT extends BaseTable<infer S, any, any, any>
       ? S
       : never
     : never;

package/src/client/table-occurrence.ts

@@ -1,4 +1,4 @@
-import { BaseTable, BaseTableWithIds } from "./base-table";
+import { BaseTable } from "./base-table";
 
 // Helper type to extract schema from BaseTable
 type ExtractSchema<BT> =
@@ -51,16 +51,19 @@ export class TableOccurrence<
   protected _navigationConfig: Nav;
   public readonly navigation: ResolveNavigation<Nav>;
   public readonly defaultSelect: DefSelect;
+  public readonly fmtId?: `FMTID:${string}`;
   constructor(config: {
     readonly name: Name;
     readonly baseTable: BT;
     readonly navigation?: Nav;
     readonly defaultSelect?: DefSelect;
+    readonly fmtId?: `FMTID:${string}`;
   }) {
     this.name = config.name;
     this.baseTable = config.baseTable;
     this._navigationConfig = (config.navigation ?? {}) as Nav;
     this.defaultSelect = (config.defaultSelect ?? "schema") as DefSelect;
+    this.fmtId = config.fmtId;
     // Create navigation getters that lazily resolve functions
     this.navigation = createNavigationGetters(this._navigationConfig);
   }
@@ -77,6 +80,7 @@ export class TableOccurrence<
       baseTable: this.baseTable,
       navigation: { ...this._navigationConfig, ...nav } as Nav & NewNav,
       defaultSelect: this.defaultSelect,
+      fmtId: this.fmtId,
     });
   }
 
@@ -85,10 +89,7 @@ export class TableOccurrence<
    * @returns The FMTID string or the table name
    */
   getTableId(): string {
-    // Check if fmtId exists (only on TableOccurrenceWithIds)
-    return "fmtId" in this && (this as any).fmtId
-      ? (this as any).fmtId
-      : this.name;
+    return this.fmtId ?? this.name;
   }
 
   /**
@@ -103,7 +104,7 @@ export class TableOccurrence<
    * Returns true if this TableOccurrence is using FileMaker table occurrence IDs.
    */
   isUsingTableId(): boolean {
-    return "fmtId" in this && this.fmtId !== undefined;
+    return this.fmtId !== undefined;
   }
 }
 
@@ -119,96 +120,56 @@ export function createTableOccurrence<
   name: Name;
   baseTable: BT;
   defaultSelect?: DefSelect;
+  fmtId?: `FMTID:${string}`;
 }): TableOccurrence<BT, Name, {}, DefSelect> {
   return new TableOccurrence(config);
 }
 
-// Helper type to validate that all navigation values are TableOccurrenceWithIds
-type ValidateNavWithIds<Nav> =
-  Nav extends Record<
-    string,
-    | TableOccurrenceWithIds<any, any, any, any>
-    | (() => TableOccurrenceWithIds<any, any, any, any>)
-  >
-    ? Nav
-    : "Error: All navigation table occurrences must be TableOccurrenceWithIds when using TableOccurrenceWithIds";
-
 /**
- * TableOccurrenceWithIds extends TableOccurrence to require:
- * 1. A BaseTableWithIds (which has fmfIds defined)
- * 2. A required fmtId for this table occurrence
- * 3. All navigation relationships must also be TableOccurrenceWithIds
- *
- * This ensures bidirectional type-level enforcement: if you use FileMaker IDs,
- * they must be defined on both the BaseTable (fmfIds) and TableOccurrence (fmtId),
- * and all related table occurrences in navigation must also have IDs.
+ * Creates a TableOccurrence with proper TypeScript type inference.
  *
- * @template BT - Must be a BaseTableWithIds (enforced at type level)
- * @template Name - The name of this table occurrence
- * @template Nav - Navigation relationships (must all be TableOccurrenceWithIds)
- * @template DefSelect - Default select behavior
+ * Use this function instead of `new TableOccurrence()` to ensure
+ * field names are properly typed.
  *
- * @example
+ * @example Without entity IDs
  * ```ts
- * const usersBaseWithIds = new BaseTableWithIds({
- *   schema: { id: z.string(), name: z.string() },
- *   idField: "id",
- *   fmfIds: { id: "FMFID:1", name: "FMFID:2" },
+ * const users = defineTableOccurrence({
+ *   name: "users",
+ *   baseTable: usersBase,
  * });
+ * ```
  *
- * const usersTO = new TableOccurrenceWithIds({
- *   name: "users",
- *   baseTable: usersBaseWithIds,
- *   fmtId: "FMTID:100",
- *   navigation: {
- *     contacts: () => contactsTO, // Must also be TableOccurrenceWithIds
- *   },
+ * @example With entity IDs
+ * ```ts
+ * const products = defineTableOccurrence({
+ *   name: "products",
+ *   baseTable: productsBase,
+ *   fmtId: "FMTID:12345",
  * });
  * ```
  */
-export class TableOccurrenceWithIds<
-  BT extends BaseTableWithIds<any, any, any, any> = any,
-  Name extends string = string,
-  Nav extends Record<
-    string,
-    | TableOccurrence<any, any, any, any>
-    | (() => TableOccurrence<any, any, any, any>)
-  > = {},
-  DefSelect extends
-    | "all"
-    | "schema"
-    | readonly (keyof ExtractSchema<BT>)[] = "schema",
-> extends TableOccurrence<BT, Name, Nav, DefSelect> {
-  public readonly fmtId: `FMTID:${string}`;
-
-  constructor(config: {
-    readonly name: Name;
-    readonly baseTable: BT;
-    readonly fmtId: `FMTID:${string}`;
-    readonly navigation?: ValidateNavWithIds<Nav>;
-    readonly defaultSelect?: DefSelect;
-  }) {
-    super({
-      ...config,
-      navigation: config.navigation as Nav,
-    });
-    this.fmtId = config.fmtId;
-  }
-}
-
-// Helper function to create TableOccurrenceWithIds with proper type inference
-export function createTableOccurrenceWithIds<
+export function defineTableOccurrence<
   const Name extends string,
-  BT extends BaseTableWithIds<any, any, any, any>,
-  DefSelect extends
+  BT extends BaseTable<any, any, any, any>,
+  const DefSelect extends
     | "all"
     | "schema"
     | readonly (keyof ExtractSchema<BT>)[] = "schema",
 >(config: {
-  name: Name;
-  baseTable: BT;
-  fmtId: `FMTID:${string}`;
-  defaultSelect?: DefSelect;
-}): TableOccurrenceWithIds<BT, Name, {}, DefSelect> {
-  return new TableOccurrenceWithIds(config);
+  readonly name: Name;
+  readonly baseTable: BT;
+  readonly fmtId?: `FMTID:${string}`;
+  readonly defaultSelect?: DefSelect;
+  readonly navigation?: Record<
+    string,
+    | TableOccurrence<any, any, any, any>
+    | (() => TableOccurrence<any, any, any, any>)
+  >;
+}): TableOccurrence<BT, Name, {}, DefSelect> {
+  return new TableOccurrence(config) as TableOccurrence<
+    BT,
+    Name,
+    {},
+    DefSelect
+  >;
 }

package/src/index.ts

@@ -1,10 +1,9 @@
 // Barrel file - exports all public API from the client folder
-export { BaseTable, BaseTableWithIds } from "./client/base-table";
+export { BaseTable, defineBaseTable } from "./client/base-table";
 export {
   TableOccurrence,
   createTableOccurrence,
-  TableOccurrenceWithIds,
-  createTableOccurrenceWithIds,
+  defineTableOccurrence,
 } from "./client/table-occurrence";
 export { FMServerConnection } from "./client/filemaker-odata";