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

package/dist/esm/client/base-table.js

@@ -1,57 +0,0 @@
-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);
-class BaseTable {
-  constructor(config) {
-    __publicField(this, "schema");
-    __publicField(this, "idField");
-    __publicField(this, "required");
-    __publicField(this, "readOnly");
-    __publicField(this, "fmfIds");
-    this.schema = config.schema;
-    this.idField = config.idField;
-    this.required = config.required;
-    this.readOnly = config.readOnly;
-    this.fmfIds = config.fmfIds;
-  }
-  /**
-   * Returns the FileMaker field ID (FMFID) for a given field name, or the field name itself if not using IDs.
-   * @param fieldName - The field name to get the ID for
-   * @returns The FMFID string or the original field name
-   */
-  getFieldId(fieldName) {
-    if (this.fmfIds && fieldName in this.fmfIds) {
-      return this.fmfIds[fieldName];
-    }
-    return String(fieldName);
-  }
-  /**
-   * Returns the field name for a given FileMaker field ID (FMFID), or the ID itself if not found.
-   * @param fieldId - The FMFID to get the field name for
-   * @returns The field name or the original ID
-   */
-  getFieldName(fieldId) {
-    if (this.fmfIds) {
-      for (const [fieldName, fmfId] of Object.entries(this.fmfIds)) {
-        if (fmfId === fieldId) {
-          return fieldName;
-        }
-      }
-    }
-    return fieldId;
-  }
-  /**
-   * Returns true if this BaseTable is using FileMaker field IDs.
-   */
-  isUsingFieldIds() {
-    return this.fmfIds !== void 0;
-  }
-}
-function defineBaseTable(config) {
-  return new BaseTable(config);
-}
-export {
-  BaseTable,
-  defineBaseTable
-};
-//# sourceMappingURL=base-table.js.map

package/dist/esm/client/base-table.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"base-table.js","sources":["../../../src/client/base-table.ts"],"sourcesContent":["import { StandardSchemaV1 } from \"@standard-schema/spec\";\n\n/**\n * BaseTable defines the schema and configuration for a table.\n *\n * @template Schema - Record of field names to StandardSchemaV1 validators\n * @template IdField - The name of the primary key field (optional, automatically read-only)\n * @template Required - Additional field names to require on insert (beyond auto-inferred required fields)\n * @template ReadOnly - Field names that cannot be modified via insert/update (idField is automatically read-only)\n *\n * @example Basic table with auto-inferred required fields\n * ```ts\n * import { z } from \"zod\";\n *\n * const usersTable = new BaseTable({\n *   schema: {\n *     id: z.string(),               // Auto-required (not nullable), auto-readOnly (idField)\n *     name: z.string(),             // Auto-required (not nullable)\n *     email: z.string().nullable(), // Optional (nullable)\n *   },\n *   idField: \"id\",\n * });\n * // On insert: name is required, email is optional (id is excluded - readOnly)\n * // On update: name and email available (id is excluded - readOnly)\n * ```\n *\n * @example Table with additional required and readOnly fields\n * ```ts\n * import { z } from \"zod\";\n *\n * const usersTable = new BaseTable({\n *   schema: {\n *     id: z.string(),                    // Auto-required, auto-readOnly (idField)\n *     createdAt: z.string(),             // Read-only system field\n *     name: z.string(),                  // Auto-required\n *     email: z.string().nullable(),      // Optional by default...\n *     legacyField: z.string().nullable(), // Optional by default...\n *   },\n *   idField: \"id\",\n *   required: [\"legacyField\"],  // Make legacyField required for new inserts\n *   readOnly: [\"createdAt\"],    // Exclude from insert/update\n * });\n * // On insert: name and legacyField required; email optional (id and createdAt excluded)\n * // On update: all fields optional (id and createdAt excluded)\n * ```\n *\n * @example Table with multiple read-only fields\n * ```ts\n * import { z } from \"zod\";\n *\n * const usersTable = new BaseTable({\n *   schema: {\n *     id: z.string(),\n *     createdAt: z.string(),\n *     modifiedAt: z.string(),\n *     createdBy: z.string(),\n *     notes: z.string().nullable(),\n *   },\n *   idField: \"id\",\n *   readOnly: [\"createdAt\", \"modifiedAt\", \"createdBy\"],\n * });\n * // On insert/update: only notes is available (id and system fields excluded)\n * ```\n */\nexport class BaseTable<\n  Schema extends Record<string, StandardSchemaV1> = any,\n  IdField extends keyof Schema | undefined = undefined,\n  Required extends readonly (keyof Schema | (string & {}))[] = readonly [],\n  ReadOnly extends readonly (keyof Schema | (string & {}))[] = readonly [],\n> {\n  public readonly schema: Schema;\n  public readonly idField?: IdField;\n  public readonly required?: Required;\n  public readonly readOnly?: ReadOnly;\n  public readonly fmfIds?: Record<\n    keyof Schema | (string & {}),\n    `FMFID:${string}`\n  >;\n\n  constructor(config: {\n    schema: Schema;\n    idField?: IdField;\n    required?: Required;\n    readOnly?: ReadOnly;\n    fmfIds?: Record<string, `FMFID:${string}`>;\n  }) {\n    this.schema = config.schema;\n    this.idField = config.idField;\n    this.required = config.required;\n    this.readOnly = config.readOnly;\n    this.fmfIds = config.fmfIds as\n      | Record<keyof Schema, `FMFID:${string}`>\n      | undefined;\n  }\n\n  /**\n   * Returns the FileMaker field ID (FMFID) for a given field name, or the field name itself if not using IDs.\n   * @param fieldName - The field name to get the ID for\n   * @returns The FMFID string or the original field name\n   */\n  getFieldId(fieldName: keyof Schema): string {\n    if (this.fmfIds && fieldName in this.fmfIds) {\n      return this.fmfIds[fieldName];\n    }\n    return String(fieldName);\n  }\n\n  /**\n   * Returns the field name for a given FileMaker field ID (FMFID), or the ID itself if not found.\n   * @param fieldId - The FMFID to get the field name for\n   * @returns The field name or the original ID\n   */\n  getFieldName(fieldId: string): string {\n    if (this.fmfIds) {\n      // Search for the field name that corresponds to this FMFID\n      for (const [fieldName, fmfId] of Object.entries(this.fmfIds)) {\n        if (fmfId === fieldId) {\n          return fieldName;\n        }\n      }\n    }\n    return fieldId;\n  }\n\n  /**\n   * Returns true if this BaseTable is using FileMaker field IDs.\n   */\n  isUsingFieldIds(): boolean {\n    return this.fmfIds !== undefined;\n  }\n}\n\n/**\n * Creates a BaseTable with proper TypeScript type inference.\n *\n * This function should be used instead of `new BaseTable()` to ensure\n * field names are properly typed throughout the library.\n *\n * @example Without entity IDs\n * ```ts\n * const users = defineBaseTable({\n *   schema: { id: z.string(), name: z.string() },\n *   idField: \"id\",\n * });\n * ```\n *\n * @example With entity IDs (FileMaker field IDs)\n * ```ts\n * const products = defineBaseTable({\n *   schema: { id: z.string(), name: z.string() },\n *   idField: \"id\",\n *   fmfIds: { id: \"FMFID:1\", name: \"FMFID:2\" },\n * });\n * ```\n */\nexport function defineBaseTable<\n  const Schema extends Record<string, StandardSchemaV1>,\n  IdField extends keyof Schema | undefined = undefined,\n  const Required extends readonly (\n    | keyof Schema\n    | (string & {})\n  )[] = readonly [],\n  const ReadOnly extends readonly (\n    | keyof Schema\n    | (string & {})\n  )[] = readonly [],\n>(config: {\n  schema: Schema;\n  idField?: IdField;\n  required?: Required;\n  readOnly?: ReadOnly;\n  fmfIds?: { [K in keyof Schema | (string & {})]: `FMFID:${string}` };\n}): BaseTable<Schema, IdField, Required, ReadOnly> {\n  return new BaseTable(config);\n}\n"],"names":[],"mappings":";;;AAgEO,MAAM,UAKX;AAAA,EAUA,YAAY,QAMT;AAfa;AACA;AACA;AACA;AACA;AAYd,SAAK,SAAS,OAAO;AACrB,SAAK,UAAU,OAAO;AACtB,SAAK,WAAW,OAAO;AACvB,SAAK,WAAW,OAAO;AACvB,SAAK,SAAS,OAAO;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUvB,WAAW,WAAiC;AAC1C,QAAI,KAAK,UAAU,aAAa,KAAK,QAAQ;AACpC,aAAA,KAAK,OAAO,SAAS;AAAA,IAAA;AAE9B,WAAO,OAAO,SAAS;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQzB,aAAa,SAAyB;AACpC,QAAI,KAAK,QAAQ;AAEJ,iBAAA,CAAC,WAAW,KAAK,KAAK,OAAO,QAAQ,KAAK,MAAM,GAAG;AAC5D,YAAI,UAAU,SAAS;AACd,iBAAA;AAAA,QAAA;AAAA,MACT;AAAA,IACF;AAEK,WAAA;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA,EAMT,kBAA2B;AACzB,WAAO,KAAK,WAAW;AAAA,EAAA;AAE3B;AAyBO,SAAS,gBAWd,QAMiD;AAC1C,SAAA,IAAI,UAAU,MAAM;AAC7B;"}