@jd-data-limited/easy-fm 4.1.14 → 5.0.0-beta.1

package/dist/models/apiResults.d.ts

@@ -1,97 +1,212 @@
-export declare enum ApiFieldTypes {
-    NORMAL = "normal",
-    CALCULATION = "calculation",
-    SUMMARY = "summary"
-}
-export declare enum ApiFieldDisplayTypes {
-    EDIT_TEXT = "editText",
-    POPUP_LIST = "popupList",
-    CHECKBOX = "checkBox",
-    RADIO_BUTTONS = "radioButtons",
-    SELECTION_LIST = "selectionList",
-    CALENDAR = "calendar",
-    SECURE_TEXT = "secureText"
-}
-export declare enum ApiFieldResultTypes {
-    TEXT = "text",
-    NUMBER = "number",
-    DATE = "date",
-    TIME = "time",
-    TIMESTAMP = "timeStamp",
-    CONTAINER = "container"
-}
-export interface ApiMessage {
-    code: string;
-    message: string;
-}
-export interface ApiResults<T = unknown> {
-    response?: null | T & {
-        scriptError?: string;
-    };
-    messages: ApiMessage[];
-    httpStatus: number;
-}
-export interface ApiLayout {
+import { z } from 'zod';
+export declare const ApiFieldTypes: {
+    readonly NORMAL: "normal";
+    readonly CALCULATION: "calculation";
+    readonly SUMMARY: "summary";
+};
+export declare const ApiFieldDisplayTypes: {
+    readonly EDIT_TEXT: "editText";
+    readonly POPUP_LIST: "popupList";
+    readonly CHECKBOX: "checkBox";
+    readonly RADIO_BUTTONS: "radioButtons";
+    readonly SELECTION_LIST: "selectionList";
+    readonly CALENDAR: "calendar";
+    readonly SECURE_TEXT: "secureText";
+};
+export declare const ApiFieldResultTypes: {
+    readonly TEXT: "text";
+    readonly NUMBER: "number";
+    readonly DATE: "date";
+    readonly TIME: "time";
+    readonly TIMESTAMP: "timeStamp";
+    readonly CONTAINER: "container";
+};
+export declare const ApiMessage: z.ZodObject<{
+    code: z.ZodCoercedNumber<unknown>;
+    message: z.ZodString;
+}, z.core.$strip>;
+export declare const ApiResults: z.ZodObject<{
+    messages: z.ZodArray<z.ZodObject<{
+        code: z.ZodCoercedNumber<unknown>;
+        message: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const ApiLayout: z.ZodType<{
     name: string;
     isFolder?: boolean;
-    folderLayoutNames?: ApiLayout[];
-}
-export interface ApiLayoutMetadata {
-    fieldMetaData: ApiFieldMetadata[];
-    portalMetaData: Record<string, ApiFieldMetadata[]>;
-    valueLists: ApiValueList[];
-}
-export interface ApiFieldMetadata {
-    name: string;
-    type: ApiFieldTypes;
-    displayType: ApiFieldDisplayTypes;
-    result: ApiFieldResultTypes;
-    global: boolean;
-    autoEnter: boolean;
-    fourDigitYear: boolean;
-    maxRepeat: number;
-    maxCharacters: number;
-    notEmpty: boolean;
-    numeric: boolean;
-    repetitions: number;
-    timeOfDay: boolean;
-    valueList: string;
-}
-export interface ApiValueList {
-    name: string;
-    type: string;
-    values: Array<{
-        value: string;
-        displayName: string;
+    folderLayoutNames?: Array<z.infer<typeof ApiLayout>>;
+}>;
+export declare const ApiFieldMetadata: z.ZodObject<{
+    name: z.ZodString;
+    type: z.ZodEnum<{
+        readonly NORMAL: "normal";
+        readonly CALCULATION: "calculation";
+        readonly SUMMARY: "summary";
+    }>;
+    displayType: z.ZodEnum<{
+        readonly EDIT_TEXT: "editText";
+        readonly POPUP_LIST: "popupList";
+        readonly CHECKBOX: "checkBox";
+        readonly RADIO_BUTTONS: "radioButtons";
+        readonly SELECTION_LIST: "selectionList";
+        readonly CALENDAR: "calendar";
+        readonly SECURE_TEXT: "secureText";
     }>;
-}
-export interface ApiScriptResult {
-    scriptError: string;
-    scriptResult?: string;
-}
-export interface ApiRecordResponseObj {
-    data: ApiRowDataDef[];
-    dataInfo: ApiResultSetObj;
-}
-export type ApiFieldData = Record<string, string | number>;
-export type ApiPortalData = Record<string, ApiFieldData[]>;
-export interface ApiResultSetObj {
-    database: string;
-    layout: string;
-    table: string;
-    totalRecordCount: number;
-    foundCount: number;
-    returnedCount: number;
-}
-export interface ApiRowDataDef {
-    fieldData: ApiFieldData;
-    portalData: ApiPortalData;
-    modId: string;
-    recordId: string;
-    portalDataInfo?: Array<{
-        database: string;
-        table: string;
-        foundCount: number;
-        returnedCount: number;
+    result: z.ZodEnum<{
+        readonly TEXT: "text";
+        readonly NUMBER: "number";
+        readonly DATE: "date";
+        readonly TIME: "time";
+        readonly TIMESTAMP: "timeStamp";
+        readonly CONTAINER: "container";
     }>;
-}
+    global: z.ZodBoolean;
+    autoEnter: z.ZodBoolean;
+    fourDigitYear: z.ZodBoolean;
+    maxRepeat: z.ZodCoercedNumber<unknown>;
+    maxCharacters: z.ZodCoercedNumber<unknown>;
+    notEmpty: z.ZodBoolean;
+    numeric: z.ZodBoolean;
+    repetitionStart: z.ZodCoercedNumber<unknown>;
+    repetitionEnd: z.ZodCoercedNumber<unknown>;
+    timeOfDay: z.ZodBoolean;
+    valueList: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const ApiValueList: z.ZodObject<{
+    name: z.ZodString;
+    type: z.ZodString;
+    values: z.ZodArray<z.ZodObject<{
+        value: z.ZodString;
+        displayName: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const ApiLayoutMetadata: z.ZodObject<{
+    fieldMetaData: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        type: z.ZodEnum<{
+            readonly NORMAL: "normal";
+            readonly CALCULATION: "calculation";
+            readonly SUMMARY: "summary";
+        }>;
+        displayType: z.ZodEnum<{
+            readonly EDIT_TEXT: "editText";
+            readonly POPUP_LIST: "popupList";
+            readonly CHECKBOX: "checkBox";
+            readonly RADIO_BUTTONS: "radioButtons";
+            readonly SELECTION_LIST: "selectionList";
+            readonly CALENDAR: "calendar";
+            readonly SECURE_TEXT: "secureText";
+        }>;
+        result: z.ZodEnum<{
+            readonly TEXT: "text";
+            readonly NUMBER: "number";
+            readonly DATE: "date";
+            readonly TIME: "time";
+            readonly TIMESTAMP: "timeStamp";
+            readonly CONTAINER: "container";
+        }>;
+        global: z.ZodBoolean;
+        autoEnter: z.ZodBoolean;
+        fourDigitYear: z.ZodBoolean;
+        maxRepeat: z.ZodCoercedNumber<unknown>;
+        maxCharacters: z.ZodCoercedNumber<unknown>;
+        notEmpty: z.ZodBoolean;
+        numeric: z.ZodBoolean;
+        repetitionStart: z.ZodCoercedNumber<unknown>;
+        repetitionEnd: z.ZodCoercedNumber<unknown>;
+        timeOfDay: z.ZodBoolean;
+        valueList: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    portalMetaData: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        type: z.ZodEnum<{
+            readonly NORMAL: "normal";
+            readonly CALCULATION: "calculation";
+            readonly SUMMARY: "summary";
+        }>;
+        displayType: z.ZodEnum<{
+            readonly EDIT_TEXT: "editText";
+            readonly POPUP_LIST: "popupList";
+            readonly CHECKBOX: "checkBox";
+            readonly RADIO_BUTTONS: "radioButtons";
+            readonly SELECTION_LIST: "selectionList";
+            readonly CALENDAR: "calendar";
+            readonly SECURE_TEXT: "secureText";
+        }>;
+        result: z.ZodEnum<{
+            readonly TEXT: "text";
+            readonly NUMBER: "number";
+            readonly DATE: "date";
+            readonly TIME: "time";
+            readonly TIMESTAMP: "timeStamp";
+            readonly CONTAINER: "container";
+        }>;
+        global: z.ZodBoolean;
+        autoEnter: z.ZodBoolean;
+        fourDigitYear: z.ZodBoolean;
+        maxRepeat: z.ZodCoercedNumber<unknown>;
+        maxCharacters: z.ZodCoercedNumber<unknown>;
+        notEmpty: z.ZodBoolean;
+        numeric: z.ZodBoolean;
+        repetitionStart: z.ZodCoercedNumber<unknown>;
+        repetitionEnd: z.ZodCoercedNumber<unknown>;
+        timeOfDay: z.ZodBoolean;
+        valueList: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    valueLists: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        type: z.ZodString;
+        values: z.ZodArray<z.ZodObject<{
+            value: z.ZodString;
+            displayName: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export declare const ApiScriptResult: z.ZodObject<{
+    scriptError: z.ZodString;
+    scriptResult: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const ApiFieldData: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+export declare const ApiResultSetObj: z.ZodObject<{
+    database: z.ZodString;
+    layout: z.ZodString;
+    table: z.ZodString;
+    totalRecordCount: z.ZodNumber;
+    foundCount: z.ZodNumber;
+    returnedCount: z.ZodNumber;
+}, z.core.$strip>;
+export declare const ApiPortalData: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>>;
+export declare const ApiRowDataDef: z.ZodObject<{
+    fieldData: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    portalData: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>>;
+    modId: z.ZodString;
+    recordId: z.ZodString;
+    portalDataInfo: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        database: z.ZodString;
+        table: z.ZodString;
+        foundCount: z.ZodNumber;
+        returnedCount: z.ZodNumber;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export declare const ApiRecordResponseObj: z.ZodObject<{
+    data: z.ZodArray<z.ZodObject<{
+        fieldData: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        portalData: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>>;
+        modId: z.ZodString;
+        recordId: z.ZodString;
+        portalDataInfo: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            database: z.ZodString;
+            table: z.ZodString;
+            foundCount: z.ZodNumber;
+            returnedCount: z.ZodNumber;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    dataInfo: z.ZodObject<{
+        database: z.ZodString;
+        layout: z.ZodString;
+        table: z.ZodString;
+        totalRecordCount: z.ZodNumber;
+        foundCount: z.ZodNumber;
+        returnedCount: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;

package/dist/models/apiResults.js

@@ -1,28 +1,98 @@
 /*
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
-export var ApiFieldTypes;
-(function (ApiFieldTypes) {
-    ApiFieldTypes["NORMAL"] = "normal";
-    ApiFieldTypes["CALCULATION"] = "calculation";
-    ApiFieldTypes["SUMMARY"] = "summary";
-})(ApiFieldTypes || (ApiFieldTypes = {}));
-export var ApiFieldDisplayTypes;
-(function (ApiFieldDisplayTypes) {
-    ApiFieldDisplayTypes["EDIT_TEXT"] = "editText";
-    ApiFieldDisplayTypes["POPUP_LIST"] = "popupList";
-    ApiFieldDisplayTypes["CHECKBOX"] = "checkBox";
-    ApiFieldDisplayTypes["RADIO_BUTTONS"] = "radioButtons";
-    ApiFieldDisplayTypes["SELECTION_LIST"] = "selectionList";
-    ApiFieldDisplayTypes["CALENDAR"] = "calendar";
-    ApiFieldDisplayTypes["SECURE_TEXT"] = "secureText";
-})(ApiFieldDisplayTypes || (ApiFieldDisplayTypes = {}));
-export var ApiFieldResultTypes;
-(function (ApiFieldResultTypes) {
-    ApiFieldResultTypes["TEXT"] = "text";
-    ApiFieldResultTypes["NUMBER"] = "number";
-    ApiFieldResultTypes["DATE"] = "date";
-    ApiFieldResultTypes["TIME"] = "time";
-    ApiFieldResultTypes["TIMESTAMP"] = "timeStamp";
-    ApiFieldResultTypes["CONTAINER"] = "container";
-})(ApiFieldResultTypes || (ApiFieldResultTypes = {}));
+import { z } from 'zod';
+export const ApiFieldTypes = {
+    NORMAL: 'normal',
+    CALCULATION: 'calculation',
+    SUMMARY: 'summary'
+};
+export const ApiFieldDisplayTypes = {
+    EDIT_TEXT: 'editText',
+    POPUP_LIST: 'popupList',
+    CHECKBOX: 'checkBox',
+    RADIO_BUTTONS: 'radioButtons',
+    SELECTION_LIST: 'selectionList',
+    CALENDAR: 'calendar',
+    SECURE_TEXT: 'secureText'
+};
+export const ApiFieldResultTypes = {
+    TEXT: 'text',
+    NUMBER: 'number',
+    DATE: 'date',
+    TIME: 'time',
+    TIMESTAMP: 'timeStamp',
+    CONTAINER: 'container'
+};
+export const ApiMessage = z.object({
+    code: z.coerce.number(),
+    message: z.string()
+});
+export const ApiResults = z.object({
+    messages: z.array(ApiMessage)
+});
+export const ApiLayout = z.lazy(() => z.object({
+    name: z.string(),
+    isFolder: z.boolean().optional(),
+    folderLayoutNames: z.array(ApiLayout).optional(),
+}));
+export const ApiFieldMetadata = z.object({
+    name: z.string(),
+    type: z.enum(ApiFieldTypes),
+    displayType: z.enum(ApiFieldDisplayTypes),
+    result: z.enum(ApiFieldResultTypes),
+    global: z.boolean(),
+    autoEnter: z.boolean(),
+    fourDigitYear: z.boolean(),
+    maxRepeat: z.coerce.number(),
+    maxCharacters: z.coerce.number(),
+    notEmpty: z.boolean(),
+    numeric: z.boolean(),
+    repetitionStart: z.coerce.number(),
+    repetitionEnd: z.coerce.number(),
+    timeOfDay: z.boolean(),
+    valueList: z.string().optional()
+});
+export const ApiValueList = z.object({
+    name: z.string(),
+    type: z.string(),
+    values: z.array(z.object({
+        value: z.string(),
+        displayName: z.string()
+    }))
+});
+export const ApiLayoutMetadata = z.object({
+    fieldMetaData: z.array(ApiFieldMetadata),
+    portalMetaData: z.record(z.string(), z.array(ApiFieldMetadata)),
+    valueLists: z.array(ApiValueList).optional()
+});
+export const ApiScriptResult = z.object({
+    scriptError: z.string(),
+    scriptResult: z.string().optional()
+});
+export const ApiFieldData = z.record(z.string(), z.union([z.string(), z.number()]));
+export const ApiResultSetObj = z.object({
+    database: z.string(),
+    layout: z.string(),
+    table: z.string(),
+    totalRecordCount: z.number(),
+    foundCount: z.number(),
+    returnedCount: z.number()
+});
+export const ApiPortalData = z.record(z.string(), z.array(ApiFieldData));
+export const ApiRowDataDef = z.object({
+    fieldData: ApiFieldData,
+    portalData: ApiPortalData,
+    modId: z.string(),
+    recordId: z.string(),
+    portalDataInfo: z.array(z.object({
+        database: z.string(),
+        table: z.string(),
+        foundCount: z.number(),
+        returnedCount: z.number()
+    })).optional()
+});
+export const ApiRecordResponseObj = z.object({
+    data: z.array(ApiRowDataDef),
+    dataInfo: ApiResultSetObj
+});

package/dist/records/field.d.ts

@@ -2,6 +2,8 @@ import { RecordTypes } from '../types.js';
 import { type ApiFieldMetadata } from '../models/apiResults.js';
 import { type LayoutBase } from '../layouts/layoutBase.js';
 import { type Moment } from 'moment';
+import { Readable } from 'node:stream';
+import { type z } from 'zod';
 export type FieldValue = string | number | Moment | Container;
 export type Container = null;
 export interface Parentable {
@@ -12,6 +14,9 @@ export interface Parentable {
         name: string;
     };
 }
+interface StreamOptions {
+    abortSignal?: AbortSignal;
+}
 /**
  * A class representing a field in a record.
  *
@@ -24,6 +29,7 @@ export declare class Field<T extends FieldValue> {
     protected _value: T | null;
     static firstContainerDownload: Promise<any> | null;
     constructor(record: Parentable, id: string, originalContents: T);
+    /** `true` if this field has changed since it was last loaded or saved. */
     get edited(): boolean;
     /**
      * Resets the 'edited' state of this field, without changing its value
@@ -36,9 +42,12 @@ export declare class Field<T extends FieldValue> {
      * @throws {Error} Cannot set container value using set(). Use upload() instead, if the result is a 'container'.
      */
     set(content: T | null): void;
-    get metadata(): ApiFieldMetadata;
+    /** Returns the FileMaker metadata for this field. */
+    get metadata(): z.infer<typeof ApiFieldMetadata>;
+    /** Gets or sets the current field value. */
     get value(): T | null;
     set value(value: T);
+    /** Returns this field value as a string. Throws if the value is not a string. */
     get string(): string;
     /**
      * Uploads a file to the container field.
@@ -52,11 +61,17 @@ export declare class Field<T extends FieldValue> {
      */
     upload(file: File): Promise<void>;
     stream(): Promise<{
-        data: NodeJS.ReadableStream;
+        data: Readable;
         mime: string;
     }>;
+    /**
+     * Returns the container download as a Web `Response`.
+     */
+    webStream(options: StreamOptions): Promise<Response>;
+    /** Downloads the full container contents into memory. */
     arrayBuffer(): Promise<{
         data: ArrayBuffer;
         mime: string;
     }>;
 }
+export {};