@proofkit/fmdapi 5.0.3-beta.0 → 5.1.0-beta.2

package/src/client-types.ts

@@ -1,21 +1,16 @@
 import { z } from "zod/v4";
 
-export const ZFieldValue = z.union([
-  z.string(),
-  z.number(),
-  z.null(),
-  z.unknown(),
-]);
+export const ZFieldValue = z.union([z.string(), z.number(), z.null(), z.unknown()]);
 export type FieldValue = z.infer<typeof ZFieldValue>;
 
 export const ZFieldData = z.record(z.string(), ZFieldValue);
 export type FieldData = Record<string, unknown>;
 
-export type GenericPortalData = {
+export interface GenericPortalData {
   [key: string]: {
     [x: string]: string | number | null | unknown;
   };
-};
+}
 
 export type PortalsWithIds<U extends GenericPortalData = GenericPortalData> = {
   [key in keyof U]: Array<
@@ -25,9 +20,7 @@ export type PortalsWithIds<U extends GenericPortalData = GenericPortalData> = {
     }
   >;
 };
-export type UpdatePortalsWithIds<
-  U extends GenericPortalData = GenericPortalData,
-> = {
+export type UpdatePortalsWithIds<U extends GenericPortalData = GenericPortalData> = {
   [key in keyof U]: Array<
     U[key] & {
       recordId: string;
@@ -36,17 +29,14 @@ export type UpdatePortalsWithIds<
   >;
 };
 
-export type FMRecord<
-  T extends FieldData = FieldData,
-  U extends GenericPortalData = GenericPortalData,
-> = {
+export interface FMRecord<T extends FieldData = FieldData, U extends GenericPortalData = GenericPortalData> {
   fieldData: T;
   recordId: string;
   modId: string;
   portalData: PortalsWithIds<U>;
-};
+}
 
-export type ScriptParams = {
+export interface ScriptParams {
   script?: string;
   "script.param"?: string;
   "script.prerequest"?: string;
@@ -54,7 +44,7 @@ export type ScriptParams = {
   "script.presort"?: string;
   "script.presort.param"?: string;
   timeout?: number;
-};
+}
 
 const ZScriptResponse = z.object({
   scriptResult: z.string().optional(),
@@ -76,18 +66,18 @@ export const ZDataInfo = z.object({
 });
 export type DataInfo = z.infer<typeof ZDataInfo>;
 
-export type CreateParams<U extends GenericPortalData = GenericPortalData> =
-  ScriptParams & { portalData?: UpdatePortalsWithIds<U> };
+export type CreateParams<U extends GenericPortalData = GenericPortalData> = ScriptParams & {
+  portalData?: UpdatePortalsWithIds<U>;
+};
 
 export type CreateResponse = ScriptResponse & {
   recordId: string;
   modId: string;
 };
 
-export type UpdateParams<U extends GenericPortalData = GenericPortalData> =
-  CreateParams<U> & {
-    modId?: number;
-  };
+export type UpdateParams<U extends GenericPortalData = GenericPortalData> = CreateParams<U> & {
+  modId?: number;
+};
 
 export type UpdateResponse = ScriptResponse & {
   modId: string;
@@ -97,42 +87,38 @@ export type DeleteParams = ScriptParams;
 
 export type DeleteResponse = ScriptResponse;
 
-export type RangeParams = {
+export interface RangeParams {
   offset?: number;
   limit?: number;
-};
-export type RangeParamsRaw = {
+}
+export interface RangeParamsRaw {
   _offset?: number;
   _limit?: number;
-};
+}
 
-export type PortalRanges<U extends GenericPortalData = GenericPortalData> =
-  Partial<{ [key in keyof U]: RangeParams }>;
+export type PortalRanges<U extends GenericPortalData = GenericPortalData> = Partial<{ [key in keyof U]: RangeParams }>;
 
-export type PortalRangesParams<
-  U extends GenericPortalData = GenericPortalData,
-> = {
+export interface PortalRangesParams<U extends GenericPortalData = GenericPortalData> {
   portalRanges?: PortalRanges<U>;
-};
+}
 
-export type GetParams<U extends GenericPortalData = GenericPortalData> =
-  ScriptParams &
-    PortalRangesParams<U> & {
-      "layout.response"?: string;
-      dateformats?: "US" | "file_locale" | "ISO8601";
-    };
+export type GetParams<U extends GenericPortalData = GenericPortalData> = ScriptParams &
+  PortalRangesParams<U> & {
+    "layout.response"?: string;
+    dateformats?: "US" | "file_locale" | "ISO8601";
+  };
 
-export type Sort<T extends FieldData = FieldData> = {
+export interface Sort<T extends FieldData = FieldData> {
   fieldName: keyof T;
   sortOrder?: "ascend" | "descend" | (string & {});
-};
+}
 
 export type ListParams<
   T extends FieldData = FieldData,
   U extends GenericPortalData = GenericPortalData,
 > = GetParams<U> &
   RangeParams & {
-    sort?: Sort<T> | Array<Sort<T>>;
+    sort?: Sort<T> | Sort<T>[];
   };
 
 export type ListParamsRaw<
@@ -140,14 +126,14 @@ export type ListParamsRaw<
   U extends GenericPortalData = GenericPortalData,
 > = GetParams<U> &
   RangeParamsRaw & {
-    _sort?: Array<Sort<T>>;
+    _sort?: Sort<T>[];
   };
 
 export type GetResponse<
   T extends FieldData = FieldData,
   U extends GenericPortalData = GenericPortalData,
 > = ScriptResponse & {
-  data: Array<FMRecord<T, U>>;
+  data: FMRecord<T, U>[];
   dataInfo: DataInfo;
 };
 export type GetResponseOne<
@@ -161,44 +147,34 @@ export type GetResponseOne<
 type SecondLevelKeys<T> = {
   [K in keyof T]: keyof T[K];
 }[keyof T];
-export type Query<
-  T extends FieldData = FieldData,
-  U extends GenericPortalData = GenericPortalData,
-> = Partial<{
+export type Query<T extends FieldData = FieldData, U extends GenericPortalData = GenericPortalData> = Partial<{
   [key in keyof T]: T[key] extends number ? number | string : string;
 }> &
   Partial<{ [key in SecondLevelKeys<U>]?: string }> & {
     omit?: "true";
   };
 
-export type LayoutMetadataResponse = {
+export interface LayoutMetadataResponse {
   fieldMetaData: FieldMetaData[];
   portalMetaData: { [key: string]: FieldMetaData[] };
   valueLists?: ValueList[];
-};
-export type ProductInfoMetadataResponse = {
+}
+export interface ProductInfoMetadataResponse {
   name: string;
   dateFormat: string;
   timeFormat: string;
   timeStampFormat: string;
-};
-export type DatabaseMetadataResponse = {
+}
+export interface DatabaseMetadataResponse {
   databases: Array<{
     name: string;
   }>;
-};
+}
 
-export type FieldMetaData = {
+export interface FieldMetaData {
   name: string;
   type: "normal" | "calculation" | "summary";
-  displayType:
-    | "editText"
-    | "popupList"
-    | "popupMenu"
-    | "checkBox"
-    | "calendar"
-    | "radioButtons"
-    | "secureText";
+  displayType: "editText" | "popupList" | "popupMenu" | "checkBox" | "calendar" | "radioButtons" | "secureText";
   result: "text" | "number" | "date" | "time" | "timeStamp" | "container";
   global: boolean;
   autoEnter: boolean;
@@ -210,29 +186,29 @@ export type FieldMetaData = {
   repetitions: number;
   timeOfDay: boolean;
   valueList?: string;
-};
+}
 
-type ValueList = {
+interface ValueList {
   name: string;
   // TODO need to test type of value list from other file
   type: "customList" | "byField";
   values: Array<{ value: string; displayValue: string }>;
-};
+}
 
 /**
  * Represents the data returned by a call to the Data API `layouts` endpoint.
  */
-export type AllLayoutsMetadataResponse = {
+export interface AllLayoutsMetadataResponse {
   /**
    * A list of `Layout` or `LayoutsFolder` objects.
    */
   layouts: LayoutOrFolder[];
-};
+}
 
 /**
  * Represents a FileMaker layout.
  */
-export type Layout = {
+export interface Layout {
   /**
    * The name of the layout
    */
@@ -242,12 +218,12 @@ export type Layout = {
    * the layout is associated with.
    */
   table: string;
-};
+}
 
 /**
  * Represents a folder of `Layout` or `LayoutsFolder` objects.
  */
-export type LayoutsFolder = {
+export interface LayoutsFolder {
   /**
    * The name of the folder
    */
@@ -257,39 +233,39 @@ export type LayoutsFolder = {
    * A list of the Layout or LayoutsFolder objects in the folder.
    */
   folderLayoutNames?: LayoutOrFolder[];
-};
+}
 
 export type LayoutOrFolder = Layout | LayoutsFolder;
 
 /**
  * Represents the data returned by a call to the Data API `scripts` endpoint.
  */
-export type ScriptsMetadataResponse = {
+export interface ScriptsMetadataResponse {
   /**
    * A list of `Layout` or `LayoutsFolder` objects.
    */
   scripts: ScriptOrFolder[];
-};
-type Script = {
+}
+interface Script {
   name: string;
   isFolder: false;
-};
-type ScriptFolder = {
+}
+interface ScriptFolder {
   name: string;
   isFolder: true;
   folderScriptNames: ScriptOrFolder[];
-};
+}
 export type ScriptOrFolder = Script | ScriptFolder;
 
-export type RawFMResponse<T = unknown> = {
+export interface RawFMResponse<T = unknown> {
   response?: T;
   messages?: [{ code: string }];
-};
+}
 
 export class FileMakerError extends Error {
-  public readonly code: string;
+  readonly code: string;
 
-  public constructor(code: string, message: string) {
+  constructor(code: string, message: string) {
     super(message);
     this.code = code;
   }