Class FmWebProjectService

Constructors

constructor

new FmWebProjectService(
    profileStore: Pick<ProfileStore, "setActiveProfileId">,
    fmClient: Pick<
        FMClient,
        "listLayouts"
        | "getLayoutMetadata"
        | "listScripts",
    >,
    schemaService: Pick<SchemaService, "getLayoutSchema">,
    logger: Pick<Logger, "debug" | "info" | "warn" | "error">,
): FmWebProjectService
Parameters
- profileStore: Pick<ProfileStore, "setActiveProfileId">
- fmClient: Pick<FMClient, "listLayouts" | "getLayoutMetadata" | "listScripts">
- schemaService: Pick<SchemaService, "getLayoutSchema">
- logger: Pick<Logger, "debug" | "info" | "warn" | "error">
Returns FmWebProjectService
- Defined in services/fmWebProjectService.ts:44

Methods

onDidChangeProject

onDidChangeProject(listener: () => void): { dispose(): void }
Calls listener after this service writes the project file (the project now exists, or changed).
Parameters
- listener: () => void
Returns { dispose(): void }
- Defined in services/fmWebProjectService.ts:52

getWorkspaceRoot

getWorkspaceRoot(): string | undefined
Returns string | undefined
- Defined in services/fmWebProjectService.ts:57

isWorkspaceTrusted

isWorkspaceTrusted(): boolean
Returns boolean
- Defined in services/fmWebProjectService.ts:61

getProjectRoot

getProjectRoot(): string
Returns string
- Defined in services/fmWebProjectService.ts:65

initializeProject

initializeProject(projectName?: string): Promise<FmWebProjectConfig>
Parameters
- OptionalprojectName: string
Returns Promise<FmWebProjectConfig>
- Defined in services/fmWebProjectService.ts:69

ensureProjectInitialized

ensureProjectInitialized(): Promise<FmWebProjectConfig>
Returns Promise<FmWebProjectConfig>
- Defined in services/fmWebProjectService.ts:100

readProjectConfig

readProjectConfig(): Promise<FmWebProjectConfig | undefined>
Returns Promise<FmWebProjectConfig | undefined>
- Defined in services/fmWebProjectService.ts:110

setActiveProfile

setActiveProfile(profileId: string): Promise<void>
Parameters
- profileId: string
Returns Promise<void>
- Defined in services/fmWebProjectService.ts:140

loadMetadataCache

loadMetadataCache(): Promise<FmWebMetadataCache | undefined>
Returns Promise<FmWebMetadataCache | undefined>
- Defined in services/fmWebProjectService.ts:153

syncMetadata

syncMetadata(profile: ConnectionProfile): Promise<FmWebSyncSummary>
Parameters
- profile: ConnectionProfile
Returns Promise<FmWebSyncSummary>
- Defined in services/fmWebProjectService.ts:157

loadOrCreateLayout

loadOrCreateLayout(layoutId?: string): Promise<FmWebLayoutLoadResult>
Parameters
- OptionallayoutId: string
Returns Promise<FmWebLayoutLoadResult>
- Defined in services/fmWebProjectService.ts:231

saveLayout

saveLayout(
    layout: {
        schemaVersion: 1;
        id: string;
        name: string;
        fmLayoutName?: string;
        fieldOrder?: string[];
        canvas: { width: number; height: number; gridSize: number };
        objects: (
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "field";
                fmFieldName: string;
                displayType: "editBox"
                | "dropdown"
                | "checkbox"
                | "radio";
                format: "number" | "text" | "date";
                kind?: "global" | "normal" | "calculation" | "summary" | "container";
                metadata?: { type?: string; result?: string };
                result?: string;
                multiline?: boolean;
                options?: string[];
                label?: string;
                labelPosition: "none" | "top" | "right" | "left";
                required: boolean;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "text";
                text: string;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "button";
                label: string;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "portal";
                relatedContext: string;
                rowCount: number;
                columns: {
                    id: string;
                    fmFieldName: string;
                    label: string;
                    width: number;
                }[];
                scroll: boolean;
                selectableRows: boolean;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "rectangle";
                cornerRadius: number;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "image";
                src?: string;
                alt?: string;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "tabPanel";
                tabs: { id: string; label: string }[];
            }
        )[];
        styles: {
            colors: {
                canvas: string;
                surface: string;
                text: string;
                accent: string;
            };
            typography: { fontFamily: string; fontSize: number };
        };
    },
): Promise<string>
Parameters
- layout: {
      schemaVersion: 1;
      id: string;
      name: string;
      fmLayoutName?: string;
      fieldOrder?: string[];
      canvas: { width: number; height: number; gridSize: number };
      objects: (
          | {
              id: string;
              name: string;
              x: number;
              y: number;
              width: number;
              height: number;
              zIndex: number;
              anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
              style?: { token: string };
              behavior?: {
                  type?:
                      | "runScript"
                      | "goToWebLayout"
                      | "goToFmLayout"
                      | "openUrl"
                      | "showDialog";
                  scriptName?: string;
                  targetLayoutId?: string;
                  targetFmLayoutName?: string;
                  url?: string;
                  dialogId?: string;
                  parameter?: string;
              };
              type: "field";
              fmFieldName: string;
              displayType: "editBox"
              | "dropdown"
              | "checkbox"
              | "radio";
              format: "number" | "text" | "date";
              kind?: "global" | "normal" | "calculation" | "summary" | "container";
              metadata?: { type?: string; result?: string };
              result?: string;
              multiline?: boolean;
              options?: string[];
              label?: string;
              labelPosition: "none" | "top" | "right" | "left";
              required: boolean;
          }
          | {
              id: string;
              name: string;
              x: number;
              y: number;
              width: number;
              height: number;
              zIndex: number;
              anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
              style?: { token: string };
              behavior?: {
                  type?:
                      | "runScript"
                      | "goToWebLayout"
                      | "goToFmLayout"
                      | "openUrl"
                      | "showDialog";
                  scriptName?: string;
                  targetLayoutId?: string;
                  targetFmLayoutName?: string;
                  url?: string;
                  dialogId?: string;
                  parameter?: string;
              };
              type: "text";
              text: string;
          }
          | {
              id: string;
              name: string;
              x: number;
              y: number;
              width: number;
              height: number;
              zIndex: number;
              anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
              style?: { token: string };
              behavior?: {
                  type?:
                      | "runScript"
                      | "goToWebLayout"
                      | "goToFmLayout"
                      | "openUrl"
                      | "showDialog";
                  scriptName?: string;
                  targetLayoutId?: string;
                  targetFmLayoutName?: string;
                  url?: string;
                  dialogId?: string;
                  parameter?: string;
              };
              type: "button";
              label: string;
          }
          | {
              id: string;
              name: string;
              x: number;
              y: number;
              width: number;
              height: number;
              zIndex: number;
              anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
              style?: { token: string };
              behavior?: {
                  type?:
                      | "runScript"
                      | "goToWebLayout"
                      | "goToFmLayout"
                      | "openUrl"
                      | "showDialog";
                  scriptName?: string;
                  targetLayoutId?: string;
                  targetFmLayoutName?: string;
                  url?: string;
                  dialogId?: string;
                  parameter?: string;
              };
              type: "portal";
              relatedContext: string;
              rowCount: number;
              columns: {
                  id: string;
                  fmFieldName: string;
                  label: string;
                  width: number;
              }[];
              scroll: boolean;
              selectableRows: boolean;
          }
          | {
              id: string;
              name: string;
              x: number;
              y: number;
              width: number;
              height: number;
              zIndex: number;
              anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
              style?: { token: string };
              behavior?: {
                  type?:
                      | "runScript"
                      | "goToWebLayout"
                      | "goToFmLayout"
                      | "openUrl"
                      | "showDialog";
                  scriptName?: string;
                  targetLayoutId?: string;
                  targetFmLayoutName?: string;
                  url?: string;
                  dialogId?: string;
                  parameter?: string;
              };
              type: "rectangle";
              cornerRadius: number;
          }
          | {
              id: string;
              name: string;
              x: number;
              y: number;
              width: number;
              height: number;
              zIndex: number;
              anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
              style?: { token: string };
              behavior?: {
                  type?:
                      | "runScript"
                      | "goToWebLayout"
                      | "goToFmLayout"
                      | "openUrl"
                      | "showDialog";
                  scriptName?: string;
                  targetLayoutId?: string;
                  targetFmLayoutName?: string;
                  url?: string;
                  dialogId?: string;
                  parameter?: string;
              };
              type: "image";
              src?: string;
              alt?: string;
          }
          | {
              id: string;
              name: string;
              x: number;
              y: number;
              width: number;
              height: number;
              zIndex: number;
              anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
              style?: { token: string };
              behavior?: {
                  type?:
                      | "runScript"
                      | "goToWebLayout"
                      | "goToFmLayout"
                      | "openUrl"
                      | "showDialog";
                  scriptName?: string;
                  targetLayoutId?: string;
                  targetFmLayoutName?: string;
                  url?: string;
                  dialogId?: string;
                  parameter?: string;
              };
              type: "tabPanel";
              tabs: { id: string; label: string }[];
          }
      )[];
      styles: {
          colors: {
              canvas: string;
              surface: string;
              text: string;
              accent: string;
          };
          typography: { fontFamily: string; fontSize: number };
      };
  }
  - schemaVersion: 1
  - id: string
  - name: string
  - OptionalfmLayoutName?: string
  - OptionalfieldOrder?: string[]
    
    The field names of the FileMaker layout, in the order that layout shows them.
  - canvas: { width: number; height: number; gridSize: number }
  - objects: (
        | {
            id: string;
            name: string;
            x: number;
            y: number;
            width: number;
            height: number;
            zIndex: number;
            anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
            style?: { token: string };
            behavior?: {
                type?:
                    | "runScript"
                    | "goToWebLayout"
                    | "goToFmLayout"
                    | "openUrl"
                    | "showDialog";
                scriptName?: string;
                targetLayoutId?: string;
                targetFmLayoutName?: string;
                url?: string;
                dialogId?: string;
                parameter?: string;
            };
            type: "field";
            fmFieldName: string;
            displayType: "editBox"
            | "dropdown"
            | "checkbox"
            | "radio";
            format: "number" | "text" | "date";
            kind?: "global" | "normal" | "calculation" | "summary" | "container";
            metadata?: { type?: string; result?: string };
            result?: string;
            multiline?: boolean;
            options?: string[];
            label?: string;
            labelPosition: "none" | "top" | "right" | "left";
            required: boolean;
        }
        | {
            id: string;
            name: string;
            x: number;
            y: number;
            width: number;
            height: number;
            zIndex: number;
            anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
            style?: { token: string };
            behavior?: {
                type?:
                    | "runScript"
                    | "goToWebLayout"
                    | "goToFmLayout"
                    | "openUrl"
                    | "showDialog";
                scriptName?: string;
                targetLayoutId?: string;
                targetFmLayoutName?: string;
                url?: string;
                dialogId?: string;
                parameter?: string;
            };
            type: "text";
            text: string;
        }
        | {
            id: string;
            name: string;
            x: number;
            y: number;
            width: number;
            height: number;
            zIndex: number;
            anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
            style?: { token: string };
            behavior?: {
                type?:
                    | "runScript"
                    | "goToWebLayout"
                    | "goToFmLayout"
                    | "openUrl"
                    | "showDialog";
                scriptName?: string;
                targetLayoutId?: string;
                targetFmLayoutName?: string;
                url?: string;
                dialogId?: string;
                parameter?: string;
            };
            type: "button";
            label: string;
        }
        | {
            id: string;
            name: string;
            x: number;
            y: number;
            width: number;
            height: number;
            zIndex: number;
            anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
            style?: { token: string };
            behavior?: {
                type?:
                    | "runScript"
                    | "goToWebLayout"
                    | "goToFmLayout"
                    | "openUrl"
                    | "showDialog";
                scriptName?: string;
                targetLayoutId?: string;
                targetFmLayoutName?: string;
                url?: string;
                dialogId?: string;
                parameter?: string;
            };
            type: "portal";
            relatedContext: string;
            rowCount: number;
            columns: { id: string; fmFieldName: string; label: string; width: number }[];
            scroll: boolean;
            selectableRows: boolean;
        }
        | {
            id: string;
            name: string;
            x: number;
            y: number;
            width: number;
            height: number;
            zIndex: number;
            anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
            style?: { token: string };
            behavior?: {
                type?:
                    | "runScript"
                    | "goToWebLayout"
                    | "goToFmLayout"
                    | "openUrl"
                    | "showDialog";
                scriptName?: string;
                targetLayoutId?: string;
                targetFmLayoutName?: string;
                url?: string;
                dialogId?: string;
                parameter?: string;
            };
            type: "rectangle";
            cornerRadius: number;
        }
        | {
            id: string;
            name: string;
            x: number;
            y: number;
            width: number;
            height: number;
            zIndex: number;
            anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
            style?: { token: string };
            behavior?: {
                type?:
                    | "runScript"
                    | "goToWebLayout"
                    | "goToFmLayout"
                    | "openUrl"
                    | "showDialog";
                scriptName?: string;
                targetLayoutId?: string;
                targetFmLayoutName?: string;
                url?: string;
                dialogId?: string;
                parameter?: string;
            };
            type: "image";
            src?: string;
            alt?: string;
        }
        | {
            id: string;
            name: string;
            x: number;
            y: number;
            width: number;
            height: number;
            zIndex: number;
            anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
            style?: { token: string };
            behavior?: {
                type?:
                    | "runScript"
                    | "goToWebLayout"
                    | "goToFmLayout"
                    | "openUrl"
                    | "showDialog";
                scriptName?: string;
                targetLayoutId?: string;
                targetFmLayoutName?: string;
                url?: string;
                dialogId?: string;
                parameter?: string;
            };
            type: "tabPanel";
            tabs: { id: string; label: string }[];
        }
    )[]
  - styles: {
        colors: {
            canvas: string;
            surface: string;
            text: string;
            accent: string;
        };
        typography: { fontFamily: string; fontSize: number };
    }
Returns Promise<string>
- Defined in services/fmWebProjectService.ts:274

prepareLayout

prepareLayout(
    layout: {
        schemaVersion: 1;
        id: string;
        name: string;
        fmLayoutName?: string;
        fieldOrder?: string[];
        canvas: { width: number; height: number; gridSize: number };
        objects: (
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "field";
                fmFieldName: string;
                displayType: "editBox"
                | "dropdown"
                | "checkbox"
                | "radio";
                format: "number" | "text" | "date";
                kind?: "global" | "normal" | "calculation" | "summary" | "container";
                metadata?: { type?: string; result?: string };
                result?: string;
                multiline?: boolean;
                options?: string[];
                label?: string;
                labelPosition: "none" | "top" | "right" | "left";
                required: boolean;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "text";
                text: string;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "button";
                label: string;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "portal";
                relatedContext: string;
                rowCount: number;
                columns: {
                    id: string;
                    fmFieldName: string;
                    label: string;
                    width: number;
                }[];
                scroll: boolean;
                selectableRows: boolean;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "rectangle";
                cornerRadius: number;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "image";
                src?: string;
                alt?: string;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "tabPanel";
                tabs: { id: string; label: string }[];
            }
        )[];
        styles: {
            colors: {
                canvas: string;
                surface: string;
                text: string;
                accent: string;
            };
            typography: { fontFamily: string; fontSize: number };
        };
    },
): Promise<
    {
        schemaVersion: 1;
        id: string;
        name: string;
        fmLayoutName?: string;
        fieldOrder?: string[];
        canvas: { width: number; height: number; gridSize: number };
        objects: (
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "field";
                fmFieldName: string;
                displayType: "editBox"
                | "dropdown"
                | "checkbox"
                | "radio";
                format: "number" | "text" | "date";
                kind?: "global" | "normal" | "calculation" | "summary" | "container";
                metadata?: { type?: string; result?: string };
                result?: string;
                multiline?: boolean;
                options?: string[];
                label?: string;
                labelPosition: "none" | "top" | "right" | "left";
                required: boolean;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "text";
                text: string;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "button";
                label: string;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "portal";
                relatedContext: string;
                rowCount: number;
                columns: {
                    id: string;
                    fmFieldName: string;
                    label: string;
                    width: number;
                }[];
                scroll: boolean;
                selectableRows: boolean;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "rectangle";
                cornerRadius: number;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "image";
                src?: string;
                alt?: string;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "tabPanel";
                tabs: { id: string; label: string }[];
            }
        )[];
        styles: {
            colors: {
                canvas: string;
                surface: string;
                text: string;
                accent: string;
            };
            typography: { fontFamily: string; fontSize: number };
        };
    },
>
Parameters
- layout: {
      schemaVersion: 1;
      id: string;
      name: string;
      fmLayoutName?: string;
      fieldOrder?: string[];
      canvas: { width: number; height: number; gridSize: number };
      objects: (
          | {
              id: string;
              name: string;
              x: number;
              y: number;
              width: number;
              height: number;
              zIndex: number;
              anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
              style?: { token: string };
              behavior?: {
                  type?:
                      | "runScript"
                      | "goToWebLayout"
                      | "goToFmLayout"
                      | "openUrl"
                      | "showDialog";
                  scriptName?: string;
                  targetLayoutId?: string;
                  targetFmLayoutName?: string;
                  url?: string;
                  dialogId?: string;
                  parameter?: string;
              };
              type: "field";
              fmFieldName: string;
              displayType: "editBox"
              | "dropdown"
              | "checkbox"
              | "radio";
              format: "number" | "text" | "date";
              kind?: "global" | "normal" | "calculation" | "summary" | "container";
              metadata?: { type?: string; result?: string };
              result?: string;
              multiline?: boolean;
              options?: string[];
              label?: string;
              labelPosition: "none" | "top" | "right" | "left";
              required: boolean;
          }
          | {
              id: string;
              name: string;
              x: number;
              y: number;
              width: number;
              height: number;
              zIndex: number;
              anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
              style?: { token: string };
              behavior?: {
                  type?:
                      | "runScript"
                      | "goToWebLayout"
                      | "goToFmLayout"
                      | "openUrl"
                      | "showDialog";
                  scriptName?: string;
                  targetLayoutId?: string;
                  targetFmLayoutName?: string;
                  url?: string;
                  dialogId?: string;
                  parameter?: string;
              };
              type: "text";
              text: string;
          }
          | {
              id: string;
              name: string;
              x: number;
              y: number;
              width: number;
              height: number;
              zIndex: number;
              anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
              style?: { token: string };
              behavior?: {
                  type?:
                      | "runScript"
                      | "goToWebLayout"
                      | "goToFmLayout"
                      | "openUrl"
                      | "showDialog";
                  scriptName?: string;
                  targetLayoutId?: string;
                  targetFmLayoutName?: string;
                  url?: string;
                  dialogId?: string;
                  parameter?: string;
              };
              type: "button";
              label: string;
          }
          | {
              id: string;
              name: string;
              x: number;
              y: number;
              width: number;
              height: number;
              zIndex: number;
              anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
              style?: { token: string };
              behavior?: {
                  type?:
                      | "runScript"
                      | "goToWebLayout"
                      | "goToFmLayout"
                      | "openUrl"
                      | "showDialog";
                  scriptName?: string;
                  targetLayoutId?: string;
                  targetFmLayoutName?: string;
                  url?: string;
                  dialogId?: string;
                  parameter?: string;
              };
              type: "portal";
              relatedContext: string;
              rowCount: number;
              columns: {
                  id: string;
                  fmFieldName: string;
                  label: string;
                  width: number;
              }[];
              scroll: boolean;
              selectableRows: boolean;
          }
          | {
              id: string;
              name: string;
              x: number;
              y: number;
              width: number;
              height: number;
              zIndex: number;
              anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
              style?: { token: string };
              behavior?: {
                  type?:
                      | "runScript"
                      | "goToWebLayout"
                      | "goToFmLayout"
                      | "openUrl"
                      | "showDialog";
                  scriptName?: string;
                  targetLayoutId?: string;
                  targetFmLayoutName?: string;
                  url?: string;
                  dialogId?: string;
                  parameter?: string;
              };
              type: "rectangle";
              cornerRadius: number;
          }
          | {
              id: string;
              name: string;
              x: number;
              y: number;
              width: number;
              height: number;
              zIndex: number;
              anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
              style?: { token: string };
              behavior?: {
                  type?:
                      | "runScript"
                      | "goToWebLayout"
                      | "goToFmLayout"
                      | "openUrl"
                      | "showDialog";
                  scriptName?: string;
                  targetLayoutId?: string;
                  targetFmLayoutName?: string;
                  url?: string;
                  dialogId?: string;
                  parameter?: string;
              };
              type: "image";
              src?: string;
              alt?: string;
          }
          | {
              id: string;
              name: string;
              x: number;
              y: number;
              width: number;
              height: number;
              zIndex: number;
              anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
              style?: { token: string };
              behavior?: {
                  type?:
                      | "runScript"
                      | "goToWebLayout"
                      | "goToFmLayout"
                      | "openUrl"
                      | "showDialog";
                  scriptName?: string;
                  targetLayoutId?: string;
                  targetFmLayoutName?: string;
                  url?: string;
                  dialogId?: string;
                  parameter?: string;
              };
              type: "tabPanel";
              tabs: { id: string; label: string }[];
          }
      )[];
      styles: {
          colors: {
              canvas: string;
              surface: string;
              text: string;
              accent: string;
          };
          typography: { fontFamily: string; fontSize: number };
      };
  }
  - schemaVersion: 1
  - id: string
  - name: string
  - OptionalfmLayoutName?: string
  - OptionalfieldOrder?: string[]
    
    The field names of the FileMaker layout, in the order that layout shows them.
  - canvas: { width: number; height: number; gridSize: number }
  - objects: (
        | {
            id: string;
            name: string;
            x: number;
            y: number;
            width: number;
            height: number;
            zIndex: number;
            anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
            style?: { token: string };
            behavior?: {
                type?:
                    | "runScript"
                    | "goToWebLayout"
                    | "goToFmLayout"
                    | "openUrl"
                    | "showDialog";
                scriptName?: string;
                targetLayoutId?: string;
                targetFmLayoutName?: string;
                url?: string;
                dialogId?: string;
                parameter?: string;
            };
            type: "field";
            fmFieldName: string;
            displayType: "editBox"
            | "dropdown"
            | "checkbox"
            | "radio";
            format: "number" | "text" | "date";
            kind?: "global" | "normal" | "calculation" | "summary" | "container";
            metadata?: { type?: string; result?: string };
            result?: string;
            multiline?: boolean;
            options?: string[];
            label?: string;
            labelPosition: "none" | "top" | "right" | "left";
            required: boolean;
        }
        | {
            id: string;
            name: string;
            x: number;
            y: number;
            width: number;
            height: number;
            zIndex: number;
            anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
            style?: { token: string };
            behavior?: {
                type?:
                    | "runScript"
                    | "goToWebLayout"
                    | "goToFmLayout"
                    | "openUrl"
                    | "showDialog";
                scriptName?: string;
                targetLayoutId?: string;
                targetFmLayoutName?: string;
                url?: string;
                dialogId?: string;
                parameter?: string;
            };
            type: "text";
            text: string;
        }
        | {
            id: string;
            name: string;
            x: number;
            y: number;
            width: number;
            height: number;
            zIndex: number;
            anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
            style?: { token: string };
            behavior?: {
                type?:
                    | "runScript"
                    | "goToWebLayout"
                    | "goToFmLayout"
                    | "openUrl"
                    | "showDialog";
                scriptName?: string;
                targetLayoutId?: string;
                targetFmLayoutName?: string;
                url?: string;
                dialogId?: string;
                parameter?: string;
            };
            type: "button";
            label: string;
        }
        | {
            id: string;
            name: string;
            x: number;
            y: number;
            width: number;
            height: number;
            zIndex: number;
            anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
            style?: { token: string };
            behavior?: {
                type?:
                    | "runScript"
                    | "goToWebLayout"
                    | "goToFmLayout"
                    | "openUrl"
                    | "showDialog";
                scriptName?: string;
                targetLayoutId?: string;
                targetFmLayoutName?: string;
                url?: string;
                dialogId?: string;
                parameter?: string;
            };
            type: "portal";
            relatedContext: string;
            rowCount: number;
            columns: { id: string; fmFieldName: string; label: string; width: number }[];
            scroll: boolean;
            selectableRows: boolean;
        }
        | {
            id: string;
            name: string;
            x: number;
            y: number;
            width: number;
            height: number;
            zIndex: number;
            anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
            style?: { token: string };
            behavior?: {
                type?:
                    | "runScript"
                    | "goToWebLayout"
                    | "goToFmLayout"
                    | "openUrl"
                    | "showDialog";
                scriptName?: string;
                targetLayoutId?: string;
                targetFmLayoutName?: string;
                url?: string;
                dialogId?: string;
                parameter?: string;
            };
            type: "rectangle";
            cornerRadius: number;
        }
        | {
            id: string;
            name: string;
            x: number;
            y: number;
            width: number;
            height: number;
            zIndex: number;
            anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
            style?: { token: string };
            behavior?: {
                type?:
                    | "runScript"
                    | "goToWebLayout"
                    | "goToFmLayout"
                    | "openUrl"
                    | "showDialog";
                scriptName?: string;
                targetLayoutId?: string;
                targetFmLayoutName?: string;
                url?: string;
                dialogId?: string;
                parameter?: string;
            };
            type: "image";
            src?: string;
            alt?: string;
        }
        | {
            id: string;
            name: string;
            x: number;
            y: number;
            width: number;
            height: number;
            zIndex: number;
            anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
            style?: { token: string };
            behavior?: {
                type?:
                    | "runScript"
                    | "goToWebLayout"
                    | "goToFmLayout"
                    | "openUrl"
                    | "showDialog";
                scriptName?: string;
                targetLayoutId?: string;
                targetFmLayoutName?: string;
                url?: string;
                dialogId?: string;
                parameter?: string;
            };
            type: "tabPanel";
            tabs: { id: string; label: string }[];
        }
    )[]
  - styles: {
        colors: {
            canvas: string;
            surface: string;
            text: string;
            accent: string;
        };
        typography: { fontFamily: string; fontSize: number };
    }
Returns Promise<
    {
        schemaVersion: 1;
        id: string;
        name: string;
        fmLayoutName?: string;
        fieldOrder?: string[];
        canvas: { width: number; height: number; gridSize: number };
        objects: (
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "field";
                fmFieldName: string;
                displayType: "editBox"
                | "dropdown"
                | "checkbox"
                | "radio";
                format: "number" | "text" | "date";
                kind?: "global" | "normal" | "calculation" | "summary" | "container";
                metadata?: { type?: string; result?: string };
                result?: string;
                multiline?: boolean;
                options?: string[];
                label?: string;
                labelPosition: "none" | "top" | "right" | "left";
                required: boolean;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "text";
                text: string;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "button";
                label: string;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "portal";
                relatedContext: string;
                rowCount: number;
                columns: {
                    id: string;
                    fmFieldName: string;
                    label: string;
                    width: number;
                }[];
                scroll: boolean;
                selectableRows: boolean;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "rectangle";
                cornerRadius: number;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "image";
                src?: string;
                alt?: string;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: {
                    top: boolean;
                    right: boolean;
                    bottom: boolean;
                    left: boolean;
                };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "tabPanel";
                tabs: { id: string; label: string }[];
            }
        )[];
        styles: {
            colors: {
                canvas: string;
                surface: string;
                text: string;
                accent: string;
            };
            typography: { fontFamily: string; fontSize: number };
        };
    },
>
- Defined in services/fmWebProjectService.ts:285

getAvailableFields

getAvailableFields(layoutName?: string): Promise<string[]>
Parameters
- OptionallayoutName: string
Returns Promise<string[]>
- Defined in services/fmWebProjectService.ts:303

getDesignerLayouts

getDesignerLayouts(layoutNames?: string[]): Promise<DesignerLayoutMetadata[]>
Parameters
- OptionallayoutNames: string[]
Returns Promise<DesignerLayoutMetadata[]>
- Defined in services/fmWebProjectService.ts:324

getProjectConfigPath

getProjectConfigPath(): string
Returns string
- Defined in services/fmWebProjectService.ts:345

getMetadataIndexPath

getMetadataIndexPath(): string
Returns string
- Defined in services/fmWebProjectService.ts:349

getMetadataLayoutsDirPath

getMetadataLayoutsDirPath(): string
Returns string
- Defined in services/fmWebProjectService.ts:353

getLayoutsDirPath

getLayoutsDirPath(): string
Returns string
- Defined in services/fmWebProjectService.ts:357

getGeneratedDirPath

getGeneratedDirPath(): string
Returns string
- Defined in services/fmWebProjectService.ts:361

Class FmWebProjectService

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FmWebProjectService

Methods

onDidChangeProject

Parameters

Returns { dispose(): void }

getWorkspaceRoot

Returns string | undefined

isWorkspaceTrusted

Returns boolean

getProjectRoot

Returns string

initializeProject

Parameters

Returns Promise<FmWebProjectConfig>

ensureProjectInitialized

Returns Promise<FmWebProjectConfig>

readProjectConfig

Returns Promise<FmWebProjectConfig | undefined>

setActiveProfile

Parameters

Returns Promise<void>

loadMetadataCache

Returns Promise<FmWebMetadataCache | undefined>

syncMetadata

Parameters

Returns Promise<FmWebSyncSummary>

loadOrCreateLayout

Parameters

Returns Promise<FmWebLayoutLoadResult>

saveLayout

Parameters

schemaVersion: 1

id: string

name: string

OptionalfmLayoutName?: string

OptionalfieldOrder?: string[]

canvas: { width: number; height: number; gridSize: number }

styles: { colors: { canvas: string; surface: string; text: string; accent: string; }; typography: { fontFamily: string; fontSize: number };}

Returns Promise<string>

prepareLayout

Parameters

schemaVersion: 1

id: string

name: string

OptionalfmLayoutName?: string

OptionalfieldOrder?: string[]

canvas: { width: number; height: number; gridSize: number }

styles: { colors: { canvas: string; surface: string; text: string; accent: string; }; typography: { fontFamily: string; fontSize: number };}

getAvailableFields

Parameters

Returns Promise<string[]>

getDesignerLayouts

Parameters

Returns Promise<DesignerLayoutMetadata[]>

getProjectConfigPath

Returns string

getMetadataIndexPath

Returns string

getMetadataLayoutsDirPath

Returns string

getLayoutsDirPath

Returns string

getGeneratedDirPath

Returns string

Settings

On This Page

`Optional`fmLayoutName?: string

`Optional`fieldOrder?: string[]

styles: {
colors: {
canvas: string;
surface: string;
text: string;
accent: string;
};
typography: { fontFamily: string; fontSize: number };
}

`Optional`fmLayoutName?: string

`Optional`fieldOrder?: string[]

styles: {
colors: {
canvas: string;
surface: string;
text: string;
accent: string;
};
typography: { fontFamily: string; fontSize: number };
}