@proofkit/fmdapi 5.0.0-beta.0

package/dist/esm/adapters/otto.d.ts

@@ -0,0 +1,26 @@
+import { BaseFetchAdapter } from './fetch-base.js';
+import { BaseFetchAdapterOptions } from './fetch-base-types.js';
+export type Otto3APIKey = `KEY_${string}`;
+export type OttoFMSAPIKey = `dk_${string}`;
+export type OttoAPIKey = Otto3APIKey | OttoFMSAPIKey;
+export declare function isOtto3APIKey(key: string): key is Otto3APIKey;
+export declare function isOttoFMSAPIKey(key: string): key is OttoFMSAPIKey;
+export declare function isOttoAPIKey(key: string): key is OttoAPIKey;
+export declare function isOttoAuth(auth: unknown): auth is OttoAuth;
+type OttoAuth = {
+    apiKey: Otto3APIKey;
+    ottoPort?: number;
+} | {
+    apiKey: OttoFMSAPIKey;
+    ottoPort?: never;
+};
+export type OttoAdapterOptions = BaseFetchAdapterOptions & {
+    auth: OttoAuth;
+};
+export declare class OttoAdapter extends BaseFetchAdapter {
+    private apiKey;
+    private port;
+    constructor(options: OttoAdapterOptions);
+    protected getToken: () => Promise<string>;
+}
+export {};

package/dist/esm/adapters/otto.js

@@ -0,0 +1,29 @@
+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 { BaseFetchAdapter } from "./fetch-base.js";
+class OttoAdapter extends BaseFetchAdapter {
+  constructor(options) {
+    super({ ...options, refreshToken: false });
+    __publicField(this, "apiKey");
+    __publicField(this, "port");
+    __publicField(this, "getToken", async () => {
+      return this.apiKey;
+    });
+    this.apiKey = options.auth.apiKey;
+    this.port = options.auth.ottoPort;
+    if (this.apiKey.startsWith("KEY_")) {
+      this.baseUrl.port = (this.port ?? 3030).toString();
+    } else if (this.apiKey.startsWith("dk_")) {
+      this.baseUrl.pathname = `otto/${this.baseUrl.pathname.replace(/^\/+|\/+$/g, "")}`;
+    } else {
+      throw new Error(
+        "Invalid Otto API key format. Must start with 'KEY_' (Otto v3) or 'dk_' (OttoFMS)"
+      );
+    }
+  }
+}
+export {
+  OttoAdapter
+};
+//# sourceMappingURL=otto.js.map

package/dist/esm/adapters/otto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"otto.js","sources":["../../../src/adapters/otto.ts"],"sourcesContent":["import { BaseFetchAdapter } from \"./fetch-base.js\";\nimport type { BaseFetchAdapterOptions } from \"./fetch-base-types.js\";\n\nexport type Otto3APIKey = `KEY_${string}`;\nexport type OttoFMSAPIKey = `dk_${string}`;\nexport type OttoAPIKey = Otto3APIKey | OttoFMSAPIKey;\n\nexport function isOtto3APIKey(key: string): key is Otto3APIKey {\n  return key.startsWith(\"KEY_\");\n}\nexport function isOttoFMSAPIKey(key: string): key is OttoFMSAPIKey {\n  return key.startsWith(\"dk_\");\n}\nexport function isOttoAPIKey(key: string): key is OttoAPIKey {\n  return isOtto3APIKey(key) || isOttoFMSAPIKey(key);\n}\n\nexport function isOttoAuth(auth: unknown): auth is OttoAuth {\n  if (typeof auth !== \"object\" || auth === null) return false;\n  return \"apiKey\" in auth;\n}\n\ntype OttoAuth =\n  | {\n      apiKey: Otto3APIKey;\n      ottoPort?: number;\n    }\n  | { apiKey: OttoFMSAPIKey; ottoPort?: never };\n\nexport type OttoAdapterOptions = BaseFetchAdapterOptions & {\n  auth: OttoAuth;\n};\n\nexport class OttoAdapter extends BaseFetchAdapter {\n  private apiKey: OttoAPIKey | Otto3APIKey;\n  private port: number | undefined;\n\n  constructor(options: OttoAdapterOptions) {\n    super({ ...options, refreshToken: false });\n    this.apiKey = options.auth.apiKey;\n    this.port = options.auth.ottoPort;\n\n    if (this.apiKey.startsWith(\"KEY_\")) {\n      // otto v3 uses port 3030\n      this.baseUrl.port = (this.port ?? 3030).toString();\n    } else if (this.apiKey.startsWith(\"dk_\")) {\n      // otto v4 uses default port, but with /otto prefix\n      this.baseUrl.pathname = `otto/${this.baseUrl.pathname.replace(/^\\/+|\\/+$/g, \"\")}`;\n    } else {\n      throw new Error(\n        \"Invalid Otto API key format. Must start with 'KEY_' (Otto v3) or 'dk_' (OttoFMS)\",\n      );\n    }\n  }\n\n  protected override getToken = async (): Promise<string> => {\n    return this.apiKey;\n  };\n}\n"],"names":[],"mappings":";;;;AAiCO,MAAM,oBAAoB,iBAAiB;AAAA,EAIhD,YAAY,SAA6B;AACvC,UAAM,EAAE,GAAG,SAAS,cAAc,OAAO;AAJnC;AACA;AAoBW,oCAAW,YAA6B;AACzD,aAAO,KAAK;AAAA,IACd;AAlBO,SAAA,SAAS,QAAQ,KAAK;AACtB,SAAA,OAAO,QAAQ,KAAK;AAEzB,QAAI,KAAK,OAAO,WAAW,MAAM,GAAG;AAElC,WAAK,QAAQ,QAAQ,KAAK,QAAQ,MAAM,SAAS;AAAA,IACxC,WAAA,KAAK,OAAO,WAAW,KAAK,GAAG;AAEnC,WAAA,QAAQ,WAAW,QAAQ,KAAK,QAAQ,SAAS,QAAQ,cAAc,EAAE,CAAC;AAAA,IAAA,OAC1E;AACL,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IAAA;AAAA,EACF;AAMJ;"}

package/dist/esm/client-types.d.ts

@@ -0,0 +1,226 @@
+import { z } from 'zod';
+export declare const ZFieldValue: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNull, z.ZodUnknown]>;
+export type FieldValue = z.infer<typeof ZFieldValue>;
+export declare const ZFieldData: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNull, z.ZodUnknown]>>;
+export type FieldData = Record<string, unknown>;
+export type GenericPortalData = {
+    [key: string]: {
+        [x: string]: string | number | null | unknown;
+    };
+};
+export type PortalsWithIds<U extends GenericPortalData = GenericPortalData> = {
+    [key in keyof U]: Array<U[key] & {
+        recordId: string;
+        modId: string;
+    }>;
+};
+export type UpdatePortalsWithIds<U extends GenericPortalData = GenericPortalData> = {
+    [key in keyof U]: Array<U[key] & {
+        recordId: string;
+        modId?: string;
+    }>;
+};
+export type FMRecord<T extends FieldData = FieldData, U extends GenericPortalData = GenericPortalData> = {
+    fieldData: T;
+    recordId: string;
+    modId: string;
+    portalData: PortalsWithIds<U>;
+};
+export type ScriptParams = {
+    script?: string;
+    "script.param"?: string;
+    "script.prerequest"?: string;
+    "script.prerequest.param"?: string;
+    "script.presort"?: string;
+    "script.presort.param"?: string;
+    timeout?: number;
+};
+declare const ZScriptResponse: z.ZodObject<{
+    scriptResult: z.ZodOptional<z.ZodString>;
+    scriptError: z.ZodOptional<z.ZodString>;
+    "scriptResult.prerequest": z.ZodOptional<z.ZodString>;
+    "scriptError.prerequest": z.ZodOptional<z.ZodString>;
+    "scriptResult.presort": z.ZodOptional<z.ZodString>;
+    "scriptError.presort": z.ZodOptional<z.ZodString>;
+}, {}, {}>;
+export type ScriptResponse = z.infer<typeof ZScriptResponse>;
+export declare const ZDataInfo: z.ZodObject<{
+    database: z.ZodString;
+    layout: z.ZodString;
+    table: z.ZodString;
+    totalRecordCount: z.ZodNumber;
+    foundCount: z.ZodNumber;
+    returnedCount: z.ZodNumber;
+}, {}, {}>;
+export type DataInfo = z.infer<typeof ZDataInfo>;
+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 UpdateResponse = ScriptResponse & {
+    modId: string;
+};
+export type DeleteParams = ScriptParams;
+export type DeleteResponse = ScriptResponse;
+export type RangeParams = {
+    offset?: number;
+    limit?: number;
+};
+export type RangeParamsRaw = {
+    _offset?: number;
+    _limit?: number;
+};
+export type PortalRanges<U extends GenericPortalData = GenericPortalData> = Partial<{
+    [key in keyof U]: RangeParams;
+}>;
+export type 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 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>>;
+};
+export type ListParamsRaw<T extends FieldData = FieldData, U extends GenericPortalData = GenericPortalData> = GetParams<U> & RangeParamsRaw & {
+    _sort?: Array<Sort<T>>;
+};
+export type GetResponse<T extends FieldData = FieldData, U extends GenericPortalData = GenericPortalData> = ScriptResponse & {
+    data: Array<FMRecord<T, U>>;
+    dataInfo: DataInfo;
+};
+export type GetResponseOne<T extends FieldData = FieldData, U extends GenericPortalData = GenericPortalData> = ScriptResponse & {
+    data: FMRecord<T, U>;
+    dataInfo: DataInfo;
+};
+type SecondLevelKeys<T> = {
+    [K in keyof T]: keyof T[K];
+}[keyof T];
+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 = {
+    fieldMetaData: FieldMetaData[];
+    portalMetaData: {
+        [key: string]: FieldMetaData[];
+    };
+    valueLists?: ValueList[];
+};
+export type ProductInfoMetadataResponse = {
+    name: string;
+    dateFormat: string;
+    timeFormat: string;
+    timeStampFormat: string;
+};
+export type DatabaseMetadataResponse = {
+    databases: Array<{
+        name: string;
+    }>;
+};
+export type FieldMetaData = {
+    name: string;
+    type: "normal" | "calculation" | "summary";
+    displayType: "editText" | "popupList" | "popupMenu" | "checkBox" | "calendar" | "radioButtons" | "secureText";
+    result: "text" | "number" | "date" | "time" | "timeStamp" | "container";
+    global: boolean;
+    autoEnter: boolean;
+    fourDigitYear: boolean;
+    maxRepeat: number;
+    maxCharacters: number;
+    notEmpty: boolean;
+    numeric: boolean;
+    repetitions: number;
+    timeOfDay: boolean;
+    valueList?: string;
+};
+type ValueList = {
+    name: string;
+    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 = {
+    /**
+     * A list of `Layout` or `LayoutsFolder` objects.
+     */
+    layouts: LayoutOrFolder[];
+};
+/**
+ * Represents a FileMaker layout.
+ */
+export type Layout = {
+    /**
+     * The name of the layout
+     */
+    name: string;
+    /**
+     * If the node is a layout, `table` may contain the name of the table
+     * the layout is associated with.
+     */
+    table: string;
+};
+/**
+ * Represents a folder of `Layout` or `LayoutsFolder` objects.
+ */
+export type LayoutsFolder = {
+    /**
+     * The name of the folder
+     */
+    name: string;
+    isFolder: boolean;
+    /**
+     * 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 = {
+    /**
+     * A list of `Layout` or `LayoutsFolder` objects.
+     */
+    scripts: ScriptOrFolder[];
+};
+type Script = {
+    name: string;
+    isFolder: false;
+};
+type ScriptFolder = {
+    name: string;
+    isFolder: true;
+    folderScriptNames: ScriptOrFolder[];
+};
+export type ScriptOrFolder = Script | ScriptFolder;
+export type RawFMResponse<T = unknown> = {
+    response?: T;
+    messages?: [{
+        code: string;
+    }];
+};
+export declare class FileMakerError extends Error {
+    readonly code: string;
+    constructor(code: string, message: string);
+}
+export {};

package/dist/esm/client-types.js

@@ -0,0 +1,41 @@
+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 { z } from "zod";
+const ZFieldValue = z.union([
+  z.string(),
+  z.number(),
+  z.null(),
+  z.unknown()
+]);
+const ZFieldData = z.record(z.string(), ZFieldValue);
+z.object({
+  scriptResult: z.string().optional(),
+  scriptError: z.string().optional(),
+  "scriptResult.prerequest": z.string().optional(),
+  "scriptError.prerequest": z.string().optional(),
+  "scriptResult.presort": z.string().optional(),
+  "scriptError.presort": z.string().optional()
+});
+const ZDataInfo = z.object({
+  database: z.string(),
+  layout: z.string(),
+  table: z.string(),
+  totalRecordCount: z.number(),
+  foundCount: z.number(),
+  returnedCount: z.number()
+});
+class FileMakerError extends Error {
+  constructor(code, message) {
+    super(message);
+    __publicField(this, "code");
+    this.code = code;
+  }
+}
+export {
+  FileMakerError,
+  ZDataInfo,
+  ZFieldData,
+  ZFieldValue
+};
+//# sourceMappingURL=client-types.js.map

package/dist/esm/client-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-types.js","sources":["../../src/client-types.ts"],"sourcesContent":["import { z } from \"zod\";\n\nexport const ZFieldValue = z.union([\n  z.string(),\n  z.number(),\n  z.null(),\n  z.unknown(),\n]);\nexport type FieldValue = z.infer<typeof ZFieldValue>;\n\nexport const ZFieldData = z.record(z.string(), ZFieldValue);\nexport type FieldData = Record<string, unknown>;\n\nexport type GenericPortalData = {\n  [key: string]: {\n    [x: string]: string | number | null | unknown;\n  };\n};\n\nexport type PortalsWithIds<U extends GenericPortalData = GenericPortalData> = {\n  [key in keyof U]: Array<\n    U[key] & {\n      recordId: string;\n      modId: string;\n    }\n  >;\n};\nexport type UpdatePortalsWithIds<\n  U extends GenericPortalData = GenericPortalData,\n> = {\n  [key in keyof U]: Array<\n    U[key] & {\n      recordId: string;\n      modId?: string;\n    }\n  >;\n};\n\nexport type FMRecord<\n  T extends FieldData = FieldData,\n  U extends GenericPortalData = GenericPortalData,\n> = {\n  fieldData: T;\n  recordId: string;\n  modId: string;\n  portalData: PortalsWithIds<U>;\n};\n\nexport type ScriptParams = {\n  script?: string;\n  \"script.param\"?: string;\n  \"script.prerequest\"?: string;\n  \"script.prerequest.param\"?: string;\n  \"script.presort\"?: string;\n  \"script.presort.param\"?: string;\n  timeout?: number;\n};\n\nconst ZScriptResponse = z.object({\n  scriptResult: z.string().optional(),\n  scriptError: z.string().optional(),\n  \"scriptResult.prerequest\": z.string().optional(),\n  \"scriptError.prerequest\": z.string().optional(),\n  \"scriptResult.presort\": z.string().optional(),\n  \"scriptError.presort\": z.string().optional(),\n});\nexport type ScriptResponse = z.infer<typeof ZScriptResponse>;\n\nexport const ZDataInfo = z.object({\n  database: z.string(),\n  layout: z.string(),\n  table: z.string(),\n  totalRecordCount: z.number(),\n  foundCount: z.number(),\n  returnedCount: z.number(),\n});\nexport type DataInfo = z.infer<typeof ZDataInfo>;\n\nexport type CreateParams<U extends GenericPortalData = GenericPortalData> =\n  ScriptParams & { portalData?: UpdatePortalsWithIds<U> };\n\nexport type CreateResponse = ScriptResponse & {\n  recordId: string;\n  modId: string;\n};\n\nexport type UpdateParams<U extends GenericPortalData = GenericPortalData> =\n  CreateParams<U> & {\n    modId?: number;\n  };\n\nexport type UpdateResponse = ScriptResponse & {\n  modId: string;\n};\n\nexport type DeleteParams = ScriptParams;\n\nexport type DeleteResponse = ScriptResponse;\n\nexport type RangeParams = {\n  offset?: number;\n  limit?: number;\n};\nexport type RangeParamsRaw = {\n  _offset?: number;\n  _limit?: number;\n};\n\nexport type PortalRanges<U extends GenericPortalData = GenericPortalData> =\n  Partial<{ [key in keyof U]: RangeParams }>;\n\nexport type PortalRangesParams<\n  U extends GenericPortalData = GenericPortalData,\n> = {\n  portalRanges?: PortalRanges<U>;\n};\n\nexport type GetParams<U extends GenericPortalData = GenericPortalData> =\n  ScriptParams &\n    PortalRangesParams<U> & {\n      \"layout.response\"?: string;\n      dateformats?: \"US\" | \"file_locale\" | \"ISO8601\";\n    };\n\nexport type Sort<T extends FieldData = FieldData> = {\n  fieldName: keyof T;\n  sortOrder?: \"ascend\" | \"descend\" | (string & {});\n};\n\nexport type ListParams<\n  T extends FieldData = FieldData,\n  U extends GenericPortalData = GenericPortalData,\n> = GetParams<U> &\n  RangeParams & {\n    sort?: Sort<T> | Array<Sort<T>>;\n  };\n\nexport type ListParamsRaw<\n  T extends FieldData = FieldData,\n  U extends GenericPortalData = GenericPortalData,\n> = GetParams<U> &\n  RangeParamsRaw & {\n    _sort?: Array<Sort<T>>;\n  };\n\nexport type GetResponse<\n  T extends FieldData = FieldData,\n  U extends GenericPortalData = GenericPortalData,\n> = ScriptResponse & {\n  data: Array<FMRecord<T, U>>;\n  dataInfo: DataInfo;\n};\nexport type GetResponseOne<\n  T extends FieldData = FieldData,\n  U extends GenericPortalData = GenericPortalData,\n> = ScriptResponse & {\n  data: FMRecord<T, U>;\n  dataInfo: DataInfo;\n};\n\ntype SecondLevelKeys<T> = {\n  [K in keyof T]: keyof T[K];\n}[keyof T];\nexport type Query<\n  T extends FieldData = FieldData,\n  U extends GenericPortalData = GenericPortalData,\n> = Partial<{\n  [key in keyof T]: T[key] extends number ? number | string : string;\n}> &\n  Partial<{ [key in SecondLevelKeys<U>]?: string }> & {\n    omit?: \"true\";\n  };\n\nexport type LayoutMetadataResponse = {\n  fieldMetaData: FieldMetaData[];\n  portalMetaData: { [key: string]: FieldMetaData[] };\n  valueLists?: ValueList[];\n};\nexport type ProductInfoMetadataResponse = {\n  name: string;\n  dateFormat: string;\n  timeFormat: string;\n  timeStampFormat: string;\n};\nexport type DatabaseMetadataResponse = {\n  databases: Array<{\n    name: string;\n  }>;\n};\n\nexport type FieldMetaData = {\n  name: string;\n  type: \"normal\" | \"calculation\" | \"summary\";\n  displayType:\n    | \"editText\"\n    | \"popupList\"\n    | \"popupMenu\"\n    | \"checkBox\"\n    | \"calendar\"\n    | \"radioButtons\"\n    | \"secureText\";\n  result: \"text\" | \"number\" | \"date\" | \"time\" | \"timeStamp\" | \"container\";\n  global: boolean;\n  autoEnter: boolean;\n  fourDigitYear: boolean;\n  maxRepeat: number;\n  maxCharacters: number;\n  notEmpty: boolean;\n  numeric: boolean;\n  repetitions: number;\n  timeOfDay: boolean;\n  valueList?: string;\n};\n\ntype ValueList = {\n  name: string;\n  // TODO need to test type of value list from other file\n  type: \"customList\" | \"byField\";\n  values: Array<{ value: string; displayValue: string }>;\n};\n\n/**\n * Represents the data returned by a call to the Data API `layouts` endpoint.\n */\nexport type AllLayoutsMetadataResponse = {\n  /**\n   * A list of `Layout` or `LayoutsFolder` objects.\n   */\n  layouts: LayoutOrFolder[];\n};\n\n/**\n * Represents a FileMaker layout.\n */\nexport type Layout = {\n  /**\n   * The name of the layout\n   */\n  name: string;\n  /**\n   * If the node is a layout, `table` may contain the name of the table\n   * the layout is associated with.\n   */\n  table: string;\n};\n\n/**\n * Represents a folder of `Layout` or `LayoutsFolder` objects.\n */\nexport type LayoutsFolder = {\n  /**\n   * The name of the folder\n   */\n  name: string;\n  isFolder: boolean;\n  /**\n   * A list of the Layout or LayoutsFolder objects in the folder.\n   */\n  folderLayoutNames?: LayoutOrFolder[];\n};\n\nexport type LayoutOrFolder = Layout | LayoutsFolder;\n\n/**\n * Represents the data returned by a call to the Data API `scripts` endpoint.\n */\nexport type ScriptsMetadataResponse = {\n  /**\n   * A list of `Layout` or `LayoutsFolder` objects.\n   */\n  scripts: ScriptOrFolder[];\n};\ntype Script = {\n  name: string;\n  isFolder: false;\n};\ntype ScriptFolder = {\n  name: string;\n  isFolder: true;\n  folderScriptNames: ScriptOrFolder[];\n};\nexport type ScriptOrFolder = Script | ScriptFolder;\n\nexport type RawFMResponse<T = unknown> = {\n  response?: T;\n  messages?: [{ code: string }];\n};\n\nexport class FileMakerError extends Error {\n  public readonly code: string;\n\n  public constructor(code: string, message: string) {\n    super(message);\n    this.code = code;\n  }\n}\n"],"names":[],"mappings":";;;;AAEa,MAAA,cAAc,EAAE,MAAM;AAAA,EACjC,EAAE,OAAO;AAAA,EACT,EAAE,OAAO;AAAA,EACT,EAAE,KAAK;AAAA,EACP,EAAE,QAAQ;AACZ,CAAC;AAGM,MAAM,aAAa,EAAE,OAAO,EAAE,UAAU,WAAW;AAgDlC,EAAE,OAAO;AAAA,EAC/B,cAAc,EAAE,OAAO,EAAE,SAAS;AAAA,EAClC,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA,EACjC,2BAA2B,EAAE,OAAO,EAAE,SAAS;AAAA,EAC/C,0BAA0B,EAAE,OAAO,EAAE,SAAS;AAAA,EAC9C,wBAAwB,EAAE,OAAO,EAAE,SAAS;AAAA,EAC5C,uBAAuB,EAAE,OAAO,EAAE,SAAS;AAC7C,CAAC;AAGY,MAAA,YAAY,EAAE,OAAO;AAAA,EAChC,UAAU,EAAE,OAAO;AAAA,EACnB,QAAQ,EAAE,OAAO;AAAA,EACjB,OAAO,EAAE,OAAO;AAAA,EAChB,kBAAkB,EAAE,OAAO;AAAA,EAC3B,YAAY,EAAE,OAAO;AAAA,EACrB,eAAe,EAAE,OAAO;AAC1B,CAAC;AAqNM,MAAM,uBAAuB,MAAM;AAAA,EAGjC,YAAY,MAAc,SAAiB;AAChD,UAAM,OAAO;AAHC;AAId,SAAK,OAAO;AAAA,EAAA;AAEhB;"}

package/dist/esm/client.d.ts

@@ -0,0 +1,133 @@
+import { Adapter } from './adapters/core.js';
+import { CreateResponse, DeleteResponse, FMRecord, FieldData, GenericPortalData, GetResponse, GetResponseOne, ListParams, Query, UpdateResponse } from './client-types.js';
+import { StandardSchemaV1 } from '@standard-schema/spec';
+export type ClientObjectProps = {
+    /**
+     * The layout to use by default for all requests. Can be overrridden on each request.
+     */
+    layout: string;
+    schema?: {
+        /**
+         * The schema for the field data.
+         */
+        fieldData: StandardSchemaV1<FieldData>;
+        /**
+         * The schema for the portal data.
+         */
+        portalData?: StandardSchemaV1<GenericPortalData>;
+    };
+};
+type FetchOptions = {
+    fetch?: RequestInit;
+};
+declare function DataApi<Fd extends FieldData = FieldData, Pd extends GenericPortalData = GenericPortalData, Opts extends ClientObjectProps = ClientObjectProps, Adp extends Adapter = Adapter>(options: Opts & {
+    adapter: Adp;
+}): Omit<Adp, "create" | "delete" | "find" | "get" | "list" | "update" | "layoutMetadata" | "containerUpload"> & {
+    layout: Opts["layout"];
+    list: {
+        (): Promise<GetResponse<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd, Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd>>;
+        (args: ListParams<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd, Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd> & FetchOptions): Promise<GetResponse<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd, Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd>>;
+    };
+    listAll: {
+        <T extends FieldData = Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd, U extends Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd = Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd>(): Promise<FMRecord<T, U>[]>;
+        <T extends FieldData = Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd, U extends Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd = Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd>(args: ListParams<T, U> & FetchOptions): Promise<FMRecord<T, U>[]>;
+    };
+    create: <T extends Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd = Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd, U extends Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd = Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd>(args: (import('./client-types.js').ScriptParams & {
+        portalData?: import('./client-types.js').UpdatePortalsWithIds<U> | undefined;
+    } & {
+        fieldData: Partial<T>;
+    }) & FetchOptions) => Promise<CreateResponse>;
+    get: (args: (import('./client-types.js').ScriptParams & import('./client-types.js').PortalRangesParams<Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd> & {
+        "layout.response"?: string;
+        dateformats?: "US" | "file_locale" | "ISO8601";
+    } & {
+        recordId: number | string;
+    }) & FetchOptions) => Promise<GetResponse<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd, Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd>>;
+    update: (args: (import('./client-types.js').ScriptParams & {
+        portalData?: import('./client-types.js').UpdatePortalsWithIds<Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd> | undefined;
+    } & {
+        modId?: number;
+    } & {
+        fieldData: Partial<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd>;
+        recordId: number | string;
+    }) & FetchOptions) => Promise<UpdateResponse>;
+    delete: (args: (import('./client-types.js').ScriptParams & {
+        recordId: number | string;
+    }) & FetchOptions) => Promise<DeleteResponse>;
+    find: (args: (import('./client-types.js').ScriptParams & import('./client-types.js').PortalRangesParams<Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd> & {
+        "layout.response"?: string;
+        dateformats?: "US" | "file_locale" | "ISO8601";
+    } & import('./client-types.js').RangeParams & {
+        sort?: import('./client-types.js').Sort<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd> | import('./client-types.js').Sort<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd>[] | undefined;
+    } & {
+        query: Query<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd> | Query<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd>[];
+        timeout?: number;
+    }) & {
+        /**
+         * If true, a find that returns no results will retun an empty array instead of throwing an error.
+         * @default false
+         */
+        ignoreEmptyResult?: boolean;
+    } & FetchOptions) => Promise<GetResponse<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd, Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd>>;
+    findOne: (args: (import('./client-types.js').ScriptParams & import('./client-types.js').PortalRangesParams<Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd> & {
+        "layout.response"?: string;
+        dateformats?: "US" | "file_locale" | "ISO8601";
+    } & import('./client-types.js').RangeParams & {
+        sort?: import('./client-types.js').Sort<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd> | import('./client-types.js').Sort<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd>[] | undefined;
+    } & {
+        query: Query<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd> | Query<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd>[];
+        timeout?: number;
+    }) & FetchOptions) => Promise<GetResponseOne<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd, Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd>>;
+    findFirst: (args: (import('./client-types.js').ScriptParams & import('./client-types.js').PortalRangesParams<Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd> & {
+        "layout.response"?: string;
+        dateformats?: "US" | "file_locale" | "ISO8601";
+    } & import('./client-types.js').RangeParams & {
+        sort?: import('./client-types.js').Sort<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd> | import('./client-types.js').Sort<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd>[] | undefined;
+    } & {
+        query: Query<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd> | Query<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd>[];
+        timeout?: number;
+    }) & {
+        /**
+         * If true, a find that returns no results will retun an empty array instead of throwing an error.
+         * @default false
+         */
+        ignoreEmptyResult?: boolean;
+    } & FetchOptions) => Promise<GetResponseOne<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd, Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd>>;
+    maybeFindFirst: (args: (import('./client-types.js').ScriptParams & import('./client-types.js').PortalRangesParams<Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd> & {
+        "layout.response"?: string;
+        dateformats?: "US" | "file_locale" | "ISO8601";
+    } & import('./client-types.js').RangeParams & {
+        sort?: import('./client-types.js').Sort<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd> | import('./client-types.js').Sort<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd>[] | undefined;
+    } & {
+        query: Query<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd> | Query<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd>[];
+        timeout?: number;
+    }) & {
+        /**
+         * If true, a find that returns no results will retun an empty array instead of throwing an error.
+         * @default false
+         */
+        ignoreEmptyResult?: boolean;
+    } & FetchOptions) => Promise<GetResponseOne<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd, Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd> | null>;
+    findAll: (args: (import('./client-types.js').ScriptParams & import('./client-types.js').PortalRangesParams<Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd> & {
+        "layout.response"?: string;
+        dateformats?: "US" | "file_locale" | "ISO8601";
+    } & import('./client-types.js').RangeParams & {
+        sort?: import('./client-types.js').Sort<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd> | import('./client-types.js').Sort<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd>[] | undefined;
+    } & {
+        query: Query<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd> | Query<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd>[];
+        timeout?: number;
+    }) & FetchOptions) => Promise<FMRecord<Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd, Opts["schema"] extends object ? Opts["schema"]["portalData"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["portalData"]> : Pd : Pd>[]>;
+    layoutMetadata: (args?: {
+        timeout?: number;
+    } & FetchOptions) => Promise<import('./client-types.js').LayoutMetadataResponse>;
+    containerUpload: <T extends Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd = Opts["schema"] extends object ? StandardSchemaV1.InferOutput<Opts["schema"]["fieldData"]> : Fd>(args: {
+        containerFieldName: keyof T;
+        containerFieldRepetition?: string | number;
+        file: Blob;
+        recordId: number | string;
+        modId?: number;
+        timeout?: number;
+    } & FetchOptions) => Promise<void>;
+};
+export default DataApi;
+export { DataApi };