@jd-data-limited/easy-fm 5.0.0-beta.5 → 5.0.0-beta.7

package/dist/bin/cli.js

@@ -40,7 +40,10 @@ program
     if (await typegen.ensureZodInstalled(dirname(configPath)))
         console.log(chalk.green('Installed Zod for generated runtime validation.'));
     const loaded = await import(pathToFileURL(configPath).href);
-    const result = await typegen.generate(loaded.default);
+    const result = await typegen.generate({ ...loaded.default, onDiagnostic: (diagnostic) => {
+            const location = [diagnostic.database, diagnostic.layout, diagnostic.portal].filter(Boolean).join('/');
+            console.warn(chalk.yellow(`Warning [${location}]: ${diagnostic.message}`));
+        } });
     console.log(chalk.green(`Generated ${result.layouts} layouts in ${result.output}`));
 });
 program.parse(process.argv);

package/dist/layouts/layout.js

@@ -3,7 +3,7 @@
  */
 import { LayoutRecordManager } from './layoutRecordManager.js';
 import { FMError } from '../FMError.js';
-import { ApiLayoutMetadata } from '../models/apiResults.js';
+import { ApiLayoutMetadata, stripInaccessibleMetadata } from '../models/apiResults.js';
 export class Layout {
     database;
     name;
@@ -37,7 +37,7 @@ export class Layout {
             return this.metadata;
         }
         const { value: res } = await this.database.execute({ type: 'layout.metadata', layout: this.name });
-        this.metadata = ApiLayoutMetadata.parse(res);
+        this.metadata = stripInaccessibleMetadata(ApiLayoutMetadata.parse(res));
         return this.metadata;
     }
 }

package/dist/models/apiResults.d.ts

@@ -7,6 +7,7 @@ export declare const ApiFieldTypes: {
 export declare const ApiFieldDisplayTypes: {
     readonly EDIT_TEXT: "editText";
     readonly POPUP_LIST: "popupList";
+    readonly POPUP_MENU: "popupMenu";
     readonly CHECKBOX: "checkBox";
     readonly RADIO_BUTTONS: "radioButtons";
     readonly SELECTION_LIST: "selectionList";
@@ -39,28 +40,29 @@ export declare const ApiLayout: z.ZodType<{
 }>;
 export declare const ApiFieldMetadata: z.ZodObject<{
     name: z.ZodString;
-    type: z.ZodEnum<{
+    type: z.ZodUnion<readonly [z.ZodEnum<{
         readonly NORMAL: "normal";
         readonly CALCULATION: "calculation";
         readonly SUMMARY: "summary";
-    }>;
+    }>, z.ZodLiteral<"invalid">]>;
     displayType: z.ZodEnum<{
         readonly EDIT_TEXT: "editText";
         readonly POPUP_LIST: "popupList";
+        readonly POPUP_MENU: "popupMenu";
         readonly CHECKBOX: "checkBox";
         readonly RADIO_BUTTONS: "radioButtons";
         readonly SELECTION_LIST: "selectionList";
         readonly CALENDAR: "calendar";
         readonly SECURE_TEXT: "secureText";
     }>;
-    result: z.ZodEnum<{
+    result: z.ZodUnion<readonly [z.ZodEnum<{
         readonly TEXT: "text";
         readonly NUMBER: "number";
         readonly DATE: "date";
         readonly TIME: "time";
         readonly TIMESTAMP: "timeStamp";
         readonly CONTAINER: "container";
-    }>;
+    }>, z.ZodLiteral<"invalid">]>;
     global: z.ZodBoolean;
     autoEnter: z.ZodBoolean;
     fourDigitYear: z.ZodBoolean;
@@ -78,34 +80,35 @@ export declare const ApiValueList: z.ZodObject<{
     type: z.ZodString;
     values: z.ZodArray<z.ZodObject<{
         value: z.ZodString;
-        displayName: z.ZodString;
+        displayName: z.ZodOptional<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<{
+        type: z.ZodUnion<readonly [z.ZodEnum<{
             readonly NORMAL: "normal";
             readonly CALCULATION: "calculation";
             readonly SUMMARY: "summary";
-        }>;
+        }>, z.ZodLiteral<"invalid">]>;
         displayType: z.ZodEnum<{
             readonly EDIT_TEXT: "editText";
             readonly POPUP_LIST: "popupList";
+            readonly POPUP_MENU: "popupMenu";
             readonly CHECKBOX: "checkBox";
             readonly RADIO_BUTTONS: "radioButtons";
             readonly SELECTION_LIST: "selectionList";
             readonly CALENDAR: "calendar";
             readonly SECURE_TEXT: "secureText";
         }>;
-        result: z.ZodEnum<{
+        result: z.ZodUnion<readonly [z.ZodEnum<{
             readonly TEXT: "text";
             readonly NUMBER: "number";
             readonly DATE: "date";
             readonly TIME: "time";
             readonly TIMESTAMP: "timeStamp";
             readonly CONTAINER: "container";
-        }>;
+        }>, z.ZodLiteral<"invalid">]>;
         global: z.ZodBoolean;
         autoEnter: z.ZodBoolean;
         fourDigitYear: z.ZodBoolean;
@@ -120,28 +123,29 @@ export declare const ApiLayoutMetadata: z.ZodObject<{
     }, z.core.$strip>>;
     portalMetaData: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
         name: z.ZodString;
-        type: z.ZodEnum<{
+        type: z.ZodUnion<readonly [z.ZodEnum<{
             readonly NORMAL: "normal";
             readonly CALCULATION: "calculation";
             readonly SUMMARY: "summary";
-        }>;
+        }>, z.ZodLiteral<"invalid">]>;
         displayType: z.ZodEnum<{
             readonly EDIT_TEXT: "editText";
             readonly POPUP_LIST: "popupList";
+            readonly POPUP_MENU: "popupMenu";
             readonly CHECKBOX: "checkBox";
             readonly RADIO_BUTTONS: "radioButtons";
             readonly SELECTION_LIST: "selectionList";
             readonly CALENDAR: "calendar";
             readonly SECURE_TEXT: "secureText";
         }>;
-        result: z.ZodEnum<{
+        result: z.ZodUnion<readonly [z.ZodEnum<{
             readonly TEXT: "text";
             readonly NUMBER: "number";
             readonly DATE: "date";
             readonly TIME: "time";
             readonly TIMESTAMP: "timeStamp";
             readonly CONTAINER: "container";
-        }>;
+        }>, z.ZodLiteral<"invalid">]>;
         global: z.ZodBoolean;
         autoEnter: z.ZodBoolean;
         fourDigitYear: z.ZodBoolean;
@@ -159,10 +163,19 @@ export declare const ApiLayoutMetadata: z.ZodObject<{
         type: z.ZodString;
         values: z.ZodArray<z.ZodObject<{
             value: z.ZodString;
-            displayName: z.ZodString;
+            displayName: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>>;
     }, z.core.$strip>>>;
 }, z.core.$strip>;
+export type ApiLayoutMetadataValue = z.infer<typeof ApiLayoutMetadata>;
+export declare function isAccessibleFieldMetadata(field: z.infer<typeof ApiFieldMetadata>): field is z.infer<typeof ApiFieldMetadata> & {
+    type: z.infer<typeof ApiFieldTypes>;
+    result: z.infer<typeof ApiFieldResultTypes>;
+};
+/** Removes FileMaker metadata placeholders for fields unavailable to the current account. */
+export declare function stripInaccessibleMetadata(metadata: ApiLayoutMetadataValue): ApiLayoutMetadataValue;
+/** Removes inaccessible placeholder values before strict generated validation. */
+export declare function stripInaccessibleFieldData<T extends Record<string, unknown>>(fields: T): T;
 export declare const ApiScriptResult: z.ZodObject<{
     scriptError: z.ZodString;
     scriptResult: z.ZodOptional<z.ZodString>;

package/dist/models/apiResults.js

@@ -10,6 +10,7 @@ export const ApiFieldTypes = {
 export const ApiFieldDisplayTypes = {
     EDIT_TEXT: 'editText',
     POPUP_LIST: 'popupList',
+    POPUP_MENU: 'popupMenu',
     CHECKBOX: 'checkBox',
     RADIO_BUTTONS: 'radioButtons',
     SELECTION_LIST: 'selectionList',
@@ -38,9 +39,9 @@ export const ApiLayout = z.lazy(() => z.object({
 }));
 export const ApiFieldMetadata = z.object({
     name: z.string(),
-    type: z.enum(ApiFieldTypes),
+    type: z.union([z.enum(ApiFieldTypes), z.literal('invalid')]),
     displayType: z.enum(ApiFieldDisplayTypes),
-    result: z.enum(ApiFieldResultTypes),
+    result: z.union([z.enum(ApiFieldResultTypes), z.literal('invalid')]),
     global: z.boolean(),
     autoEnter: z.boolean(),
     fourDigitYear: z.boolean(),
@@ -58,7 +59,7 @@ export const ApiValueList = z.object({
     type: z.string(),
     values: z.array(z.object({
         value: z.string(),
-        displayName: z.string()
+        displayName: z.string().optional()
     }))
 });
 export const ApiLayoutMetadata = z.object({
@@ -66,6 +67,25 @@ export const ApiLayoutMetadata = z.object({
     portalMetaData: z.record(z.string(), z.array(ApiFieldMetadata)),
     valueLists: z.array(ApiValueList).optional()
 });
+export function isAccessibleFieldMetadata(field) {
+    return field.type !== 'invalid' && field.result !== 'invalid' && field.name !== '<No Access>';
+}
+/** Removes FileMaker metadata placeholders for fields unavailable to the current account. */
+export function stripInaccessibleMetadata(metadata) {
+    return {
+        ...metadata,
+        fieldMetaData: metadata.fieldMetaData.filter(isAccessibleFieldMetadata),
+        portalMetaData: Object.fromEntries(Object.entries(metadata.portalMetaData).map(([name, fields]) => [name, fields.filter(isAccessibleFieldMetadata)]))
+    };
+}
+/** Removes inaccessible placeholder values before strict generated validation. */
+export function stripInaccessibleFieldData(fields) {
+    if (!Object.hasOwn(fields, '<No Access>'))
+        return fields;
+    const result = { ...fields };
+    delete result['<No Access>'];
+    return result;
+}
 export const ApiScriptResult = z.object({
     scriptError: z.string(),
     scriptResult: z.string().optional()

package/dist/records/recordBase.js

@@ -3,6 +3,7 @@
  */
 import { EventEmitter } from 'node:events';
 import { RecordTypes } from '../types.js';
+import { stripInaccessibleFieldData } from '../models/apiResults.js';
 import { DateField, NumberField, TextField, TimeField, TimeStampField, ValueFieldBase } from "./fields/valueField.js";
 import { ContainerField } from "./fields/containerField.js";
 export class RecordBase extends EventEmitter {
@@ -41,7 +42,7 @@ export class RecordBase extends EventEmitter {
     }
     processFieldData(fieldData) {
         const fields = {};
-        for (const [key, value] of Object.entries(fieldData)) {
+        for (const [key, value] of Object.entries(stripInaccessibleFieldData(fieldData))) {
             const fieldMeta = this.getFieldMetadata(key);
             let field;
             switch (fieldMeta.result) {

package/dist/schema.js

@@ -1,3 +1,4 @@
+import { stripInaccessibleFieldData, stripInaccessibleMetadata } from './models/apiResults.js';
 /** Built-in runtime adapter used by Zod-generated clients. */
 export const zodValidator = {
     validate(schema, value) {
@@ -29,19 +30,28 @@ export function withSchemaValidation(provider, schema) {
             return { formatting: connection.formatting, maxSessions: connection.maxSessions, close: connection.close?.bind(connection), async openSession(signal) {
                     const session = await connection.openSession(signal);
                     return { close: session.close.bind(session), fetchContainer: session.fetchContainer.bind(session), async execute(operation) {
-                            const result = await session.execute(operation);
-                            if (operation.type === 'layout.metadata')
+                            let result = await session.execute(operation);
+                            if (operation.type === 'layout.metadata') {
+                                result = stripInaccessibleMetadata(result);
                                 validateMetadata(schema, operation.layout, result);
-                            if (operation.type === 'record.get')
+                            }
+                            if (operation.type === 'record.get') {
+                                result = stripRecord(result);
                                 validateRecord(schema, operation.layout, result);
-                            if (operation.type === 'record.list')
+                            }
+                            if (operation.type === 'record.list') {
+                                result = result.map(stripRecord);
                                 for (const record of result)
                                     validateRecord(schema, operation.layout, record);
+                            }
                             return result;
                         } };
                 } };
         } };
 }
+function stripRecord(record) {
+    return { ...record, fieldData: stripInaccessibleFieldData(record.fieldData), portalData: record.portalData && Object.fromEntries(Object.entries(record.portalData).map(([name, rows]) => [name, rows.map(row => stripInaccessibleFieldData(row))])) };
+}
 function validateRecord(schema, layout, record) {
     const layoutSchema = schema.layouts[layout];
     if (!layoutSchema)

package/dist/typegen/dataApiSchemaSource.js

@@ -1,22 +1,26 @@
 import { Database } from '../connection/database.js';
 import { DataApiProvider } from '../connection/DataApiProvider.js';
+import { ApiLayoutMetadata, isAccessibleFieldMetadata } from '../models/apiResults.js';
 export function dataApiSchemaSource(options) {
     return {
         async introspect() {
             const database = Database.create({ provider: new DataApiProvider(options) });
             try {
                 const layouts = await database.listLayouts();
-                return {
-                    version: 1,
-                    layouts: await Promise.all(layouts.map(async (layout) => {
-                        const metadata = await layout.getLayoutMeta();
-                        return {
-                            name: layout.name,
-                            fields: unique(metadata.fieldMetaData.map(toField)),
-                            portals: Object.fromEntries(Object.entries(metadata.portalMetaData).map(([name, fields]) => [name, unique(fields.map(toField))]))
-                        };
-                    }))
-                };
+                const inspected = await Promise.all(layouts.map(async (layout) => {
+                    // Read raw metadata here so inaccessible placeholders can produce diagnostics before stripping.
+                    const { value } = await database.execute({ type: 'layout.metadata', layout: layout.name });
+                    const metadata = ApiLayoutMetadata.parse(value);
+                    const diagnostics = metadata.fieldMetaData.filter(isInaccessible).map(field => ({ level: 'warning', layout: layout.name, message: `Field ${JSON.stringify(field.name)} is inaccessible and was excluded from generated types. Check this account's field privileges.` }));
+                    for (const [portal, fields] of Object.entries(metadata.portalMetaData))
+                        for (const field of fields.filter(isInaccessible))
+                            diagnostics.push({ level: 'warning', layout: layout.name, portal, message: `Portal field ${JSON.stringify(field.name)} is inaccessible and was excluded from generated types. Check this account's field privileges.` });
+                    return {
+                        layout: { name: layout.name, fields: unique(metadata.fieldMetaData.filter(isAccessibleFieldMetadata).map(toField)), portals: Object.fromEntries(Object.entries(metadata.portalMetaData).map(([name, fields]) => [name, unique(fields.filter(isAccessibleFieldMetadata).map(toField))])) },
+                        diagnostics
+                    };
+                }));
+                return { version: 1, layouts: inspected.map(item => item.layout), diagnostics: inspected.flatMap(item => item.diagnostics) };
             }
             finally {
                 await database.close();
@@ -24,7 +28,10 @@ export function dataApiSchemaSource(options) {
         }
     };
 }
+function isInaccessible(field) { return field.type === 'invalid' || field.result === 'invalid' || field.name === '<No Access>'; }
 function toField(field) {
+    if (!isAccessibleFieldMetadata(field))
+        throw new Error('Cannot generate an inaccessible field');
     return { name: field.name, result: field.result, type: field.type, writable: field.type === 'normal', required: field.notEmpty };
 }
 function unique(fields) {

package/dist/typegen/generate.d.ts

@@ -3,4 +3,7 @@ export declare function generate(config: TypegenConfig): Promise<{
     output: string;
     layouts: number;
     databases: number;
+    diagnostics: Array<import('./types.js').TypegenDiagnostic & {
+        database: string;
+    }>;
 }>;

package/dist/typegen/generate.js

@@ -2,8 +2,14 @@ import { mkdir, rename, rm, writeFile } from 'node:fs/promises';
 import { dirname, resolve } from 'node:path';
 import { zodTypegenValidator } from './zod.js';
 export async function generate(config) {
+    const diagnostics = [];
     const databases = await Promise.all(databaseEntries(config).map(async ([key, databaseConfig]) => {
         const discovered = await databaseConfig.source.introspect();
+        for (const diagnostic of discovered.diagnostics ?? []) {
+            const item = { ...diagnostic, database: key };
+            diagnostics.push(item);
+            (config.onDiagnostic ?? defaultDiagnosticReporter)(item);
+        }
         const selected = databaseConfig.layouts ? discovered.layouts.filter(layout => databaseConfig.layouts.includes(layout.name)) : discovered.layouts;
         const missing = databaseConfig.layouts?.filter(name => !selected.some(layout => layout.name === name)) ?? [];
         if (missing.length)
@@ -20,8 +26,9 @@ export async function generate(config) {
     await mkdir(dirname(output), { recursive: true });
     await rm(output, { recursive: true, force: true });
     await rename(temporary, output);
-    return { output, databases: databases.length, layouts: databases.reduce((sum, db) => sum + db.schema.layouts.length, 0) };
+    return { output, databases: databases.length, layouts: databases.reduce((sum, db) => sum + db.schema.layouts.length, 0), diagnostics };
 }
+function defaultDiagnosticReporter(diagnostic) { console.warn(`[easyfm:typegen] warning [${diagnostic.database}${diagnostic.layout ? `/${diagnostic.layout}` : ''}${diagnostic.portal ? `/${diagnostic.portal}` : ''}]: ${diagnostic.message}`); }
 function databaseEntries(config) {
     if (config.databases && Object.keys(config.databases).length)
         return Object.entries(config.databases);

package/dist/typegen/index.d.ts

@@ -3,4 +3,4 @@ export { dataApiSchemaSource } from './dataApiSchemaSource.js';
 export { zodTypegenValidator } from './zod.js';
 export { configExists, readEnvironment, writeDataApiInitialization, writeMultiDatabaseInitialization, type DataApiInitAnswers, type MultiDatabaseInitAnswers } from './init.js';
 export { ensureZodInstalled, getZodInstallPlan, type InstallPlan } from './dependencies.js';
-export { defineTypegenConfig, type SchemaSource, type TypegenConfig, type TypegenDatabaseConfig, type TypegenField, type TypegenLayout, type TypegenSchema, type TypegenTransport, type TypegenValidator } from './types.js';
+export { defineTypegenConfig, type SchemaSource, type TypegenConfig, type TypegenDatabaseConfig, type TypegenDiagnostic, type TypegenField, type TypegenLayout, type TypegenSchema, type TypegenTransport, type TypegenValidator } from './types.js';

package/dist/typegen/types.d.ts

@@ -12,9 +12,16 @@ export interface TypegenLayout {
     fields: TypegenField[];
     portals: Record<string, TypegenField[]>;
 }
+export interface TypegenDiagnostic {
+    level: 'warning';
+    message: string;
+    layout?: string;
+    portal?: string;
+}
 export interface TypegenSchema {
     version: 1;
     layouts: TypegenLayout[];
+    diagnostics?: TypegenDiagnostic[];
 }
 export type TypegenTransport = 'data-api' | 'odata';
 export interface SchemaSource {
@@ -38,6 +45,9 @@ export interface TypegenConfig {
     /** Defaults to the built-in strict Zod validator. */
     validator?: TypegenValidator;
     databases?: Record<string, TypegenDatabaseConfig>;
+    onDiagnostic?: (diagnostic: TypegenDiagnostic & {
+        database: string;
+    }) => void;
 }
 export interface TypegenDatabaseConfig {
     source: SchemaSource;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jd-data-limited/easy-fm",
-  "version": "5.0.0-beta.5",
+  "version": "5.0.0-beta.7",
   "dependencies": {
     "chalk": "^5.6.2",
     "commander": "^15.0.0",