d365fo-mcp 1.0.0

package/dist/utils/formExtensionShapeValidator.js

@@ -0,0 +1,99 @@
+/**
+ * Form-extension control-shape validator.
+ *
+ * Catches malformed AxFormExtension control shapes in hand-written `xmlContent`
+ * (the escape hatch when add-control can't be used) that would otherwise be
+ * silently accepted and then rejected by the D365FO deserializer.
+ *
+ * Correct shape (verified against shipped standard extensions, e.g.
+ * InventItemSampling.AdvancedQualityManagement):
+ *
+ *   <AxFormExtensionControl xmlns="">
+ *     <Name>FormExtensionControl{rand}</Name>
+ *     <FormControl xmlns="" i:type="AxFormIntegerControl">
+ *       <Name>Field</Name>
+ *       <Type>Integer</Type>
+ *       <FormControlExtension i:nil="true" />
+ *       <DataField>Field</DataField>
+ *       <DataSource>Table</DataSource>
+ *       <Label>@Model:Label</Label>
+ *     </FormControl>
+ *     <Parent>ParentControl</Parent>
+ *   </AxFormExtensionControl>
+ */
+/**
+ * The canonical correct shape, shown to the caller when a problem is found so they
+ * can fix it without grepping standard packages.
+ */
+export const CORRECT_FORM_EXTENSION_CONTROL_TEMPLATE = `<AxFormExtensionControl xmlns="">\n` +
+    `    <Name>FormExtensionControl{uniqueId}</Name>\n` +
+    `    <FormControl xmlns="" i:type="AxFormIntegerControl">\n` +
+    `        <Name>FieldName</Name>\n` +
+    `        <Type>Integer</Type>\n` +
+    `        <FormControlExtension i:nil="true" />\n` +
+    `        <DataField>FieldName</DataField>\n` +
+    `        <DataSource>TableName</DataSource>\n` +
+    `        <Label>@Model:LabelId</Label>\n` +
+    `    </FormControl>\n` +
+    `    <Parent>ParentControlName</Parent>\n` +
+    `</AxFormExtensionControl>`;
+/**
+ * Inspect form-extension XML for the known malformed control shapes. Returns an empty
+ * array when the shape is fine. Pure + side-effect-free so it is trivially testable.
+ */
+export function validateFormExtensionControlShape(xml) {
+    const problems = [];
+    // Wrong wrapper element for a newly-added control.
+    if (/<AxFormControlExtension\b/.test(xml)) {
+        problems.push({
+            found: '<AxFormControlExtension>',
+            expected: '<AxFormExtensionControl xmlns="">',
+            detail: 'A new control added by a form extension is wrapped in <AxFormExtensionControl xmlns="">, ' +
+                'not <AxFormControlExtension>.',
+        });
+    }
+    // Wrong parent-reference element.
+    if (/<ParentControlName\b/.test(xml)) {
+        problems.push({
+            found: '<ParentControlName>',
+            expected: '<Parent>',
+            detail: 'The parent control is referenced with <Parent>Name</Parent>, not <ParentControlName>.',
+        });
+    }
+    // <FormControlExtension> used as the control container (wrong) — the legitimate use
+    // is the self-closing <FormControlExtension i:nil="true" /> inside a <FormControl>,
+    // which this pattern deliberately does not match.
+    if (/<FormControlExtension\s*>[\s\S]*?<AxForm\w*Control\b/.test(xml)) {
+        problems.push({
+            found: '<FormControlExtension><AxForm…Control>',
+            expected: '<FormControl xmlns="" i:type="AxForm…Control">',
+            detail: 'The control itself goes in <FormControl xmlns="" i:type="AxForm…Control">…</FormControl>. ' +
+                '<FormControlExtension i:nil="true" /> is a separate, self-closing element INSIDE that FormControl.',
+        });
+    }
+    // Non-existent integer control element.
+    if (/\bAxFormIntControl\b/.test(xml)) {
+        problems.push({
+            found: 'AxFormIntControl',
+            expected: 'AxFormIntegerControl',
+            detail: 'The integer form control class is AxFormIntegerControl (with <Type>Integer</Type>). ' +
+                'AxFormIntControl does not exist and fails deserialization.',
+        });
+    }
+    return problems;
+}
+/**
+ * Render a blocking error message for the detected problems, including the correct
+ * template so the caller can fix the XML in a single edit (no package grepping).
+ */
+export function buildFormExtensionShapeError(objectName, problems) {
+    const rows = problems
+        .map(p => `  • \`${p.found}\` → must be \`${p.expected}\`\n    ${p.detail}`)
+        .join('\n');
+    return (`⛔ form-extension "${objectName}" — the control XML uses a shape the D365FO deserializer rejects.\n\n` +
+        `Problems found:\n${rows}\n\n` +
+        `Correct shape for a bound control added to an existing parent:\n\`\`\`xml\n${CORRECT_FORM_EXTENSION_CONTROL_TEMPLATE}\n\`\`\`\n\n` +
+        `Tip: prefer d365fo_file(action="modify", operation="add-control", objectType="form-extension", …) — ` +
+        `it now emits this exact shape for you, so you rarely need to hand-write the XML.`);
+}
+//# sourceMappingURL=formExtensionShapeValidator.js.map

package/dist/utils/formExtensionShapeValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formExtensionShapeValidator.js","sourceRoot":"","sources":["../../src/utils/formExtensionShapeValidator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAQH;;;GAGG;AACH,MAAM,CAAC,MAAM,uCAAuC,GAClD,qCAAqC;IACrC,mDAAmD;IACnD,4DAA4D;IAC5D,kCAAkC;IAClC,gCAAgC;IAChC,iDAAiD;IACjD,4CAA4C;IAC5C,8CAA8C;IAC9C,yCAAyC;IACzC,sBAAsB;IACtB,0CAA0C;IAC1C,2BAA2B,CAAC;AAE9B;;;GAGG;AACH,MAAM,UAAU,iCAAiC,CAAC,GAAW;IAC3D,MAAM,QAAQ,GAA0B,EAAE,CAAC;IAE3C,mDAAmD;IACnD,IAAI,2BAA2B,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1C,QAAQ,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE,0BAA0B;YACjC,QAAQ,EAAE,mCAAmC;YAC7C,MAAM,EACJ,2FAA2F;gBAC3F,+BAA+B;SAClC,CAAC,CAAC;IACL,CAAC;IAED,kCAAkC;IAClC,IAAI,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACrC,QAAQ,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE,qBAAqB;YAC5B,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,uFAAuF;SAChG,CAAC,CAAC;IACL,CAAC;IAED,oFAAoF;IACpF,oFAAoF;IACpF,kDAAkD;IAClD,IAAI,sDAAsD,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACrE,QAAQ,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE,wCAAwC;YAC/C,QAAQ,EAAE,gDAAgD;YAC1D,MAAM,EACJ,4FAA4F;gBAC5F,oGAAoG;SACvG,CAAC,CAAC;IACL,CAAC;IAED,wCAAwC;IACxC,IAAI,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACrC,QAAQ,CAAC,IAAI,CAAC;YACZ,KAAK,EAAE,kBAAkB;YACzB,QAAQ,EAAE,sBAAsB;YAChC,MAAM,EACJ,sFAAsF;gBACtF,4DAA4D;SAC/D,CAAC,CAAC;IACL,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,4BAA4B,CAC1C,UAAkB,EAClB,QAA+B;IAE/B,MAAM,IAAI,GAAG,QAAQ;SAClB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,KAAK,kBAAkB,CAAC,CAAC,QAAQ,WAAW,CAAC,CAAC,MAAM,EAAE,CAAC;SAC3E,IAAI,CAAC,IAAI,CAAC,CAAC;IACd,OAAO,CACL,qBAAqB,UAAU,uEAAuE;QACtG,oBAAoB,IAAI,MAAM;QAC9B,8EAA8E,uCAAuC,cAAc;QACnI,sGAAsG;QACtG,kFAAkF,CACnF,CAAC;AACJ,CAAC"}

package/dist/utils/formPatternTemplates.d.ts

@@ -0,0 +1,77 @@
+/**
+ * D365FO Form Pattern Templates
+ *
+ * Each static method generates a complete, pattern-correct AxForm XML skeleton
+ * validated against real AOT forms from K:\AosService\PackagesLocalDirectory.
+ *
+ * Reference forms used:
+ *   SimpleList        → CustGroup.xml         (ApplicationSuite\Foundation)
+ *   SimpleListDetails → PaymTerm.xml          (ApplicationSuite\Foundation)
+ *   DetailsMaster     → CustTable.xml         (ApplicationSuite\Foundation)
+ *   DetailsTransaction→ SalesTable.xml        (ApplicationSuite\Foundation)
+ *   Dialog            → ProjTableCreate.xml   (ApplicationSuite\Foundation)
+ *   TableOfContents   → CustParameters.xml    (ApplicationSuite\Foundation)
+ *   Lookup            → SysLanguageLookup.xml (ApplicationPlatform)
+ */
+import { type FieldControlMap } from './fieldControlTypes.js';
+export interface FormTemplateOptions {
+    /** Form name (also used for classDeclaration) */
+    formName: string;
+    /** Primary datasource name (usually same as table name) */
+    dsName?: string;
+    /** Primary datasource table name */
+    dsTable?: string;
+    /** Caption label text or label reference (@Model:Label) */
+    caption?: string;
+    /** Field names to put in the grid (for SimpleList, Lookup, etc.) */
+    gridFields?: string[];
+    /** Section definitions for TableOfContents / Dialog */
+    sections?: Array<{
+        name: string;
+        caption: string;
+    }>;
+    /** Lines datasource name for DetailsTransaction */
+    linesDsName?: string;
+    /** Lines datasource table name for DetailsTransaction */
+    linesDsTable?: string;
+    /** Field names to show in the lines grid (DetailsTransaction) */
+    linesFields?: string[];
+    /**
+     * Field → control-type map for the primary table. When provided, field
+     * controls render with the correct type (ComboBox for enums, Date for dates,
+     * …) instead of defaulting every field to a string control.
+     */
+    fieldTypes?: FieldControlMap;
+    /** Field → control-type map for the lines table (DetailsTransaction). */
+    linesFieldTypes?: FieldControlMap;
+}
+/** Supported top-level D365FO form patterns */
+export type FormPattern = 'SimpleList' | 'SimpleListDetails' | 'DetailsMaster' | 'DetailsTransaction' | 'Dialog' | 'TableOfContents' | 'Lookup' | 'ListPage' | 'Workspace';
+export declare class FormPatternTemplates {
+    /**
+     * Render a single field input control with the correct control type.
+     *
+     * `indent` is the tab string for the opening `<AxFormControl>` line; child
+     * elements are emitted one tab deeper and the `i:type` attribute two tabs
+     * deeper, matching the surrounding AOT layout. The control type is resolved
+     * from `types` (enum→ComboBox, date→Date, …); unknown fields fall back to a
+     * string control.
+     */
+    static fieldControl(field: string, dsName: string, indent: string, namePrefix?: string, types?: FieldControlMap): string;
+    static buildSimpleList(opt: FormTemplateOptions): string;
+    static buildSimpleListDetails(opt: FormTemplateOptions): string;
+    static buildDetailsMaster(opt: FormTemplateOptions): string;
+    static buildDetailsTransaction(opt: FormTemplateOptions): string;
+    static buildDialog(opt: FormTemplateOptions): string;
+    static buildTableOfContents(opt: FormTemplateOptions): string;
+    static buildLookup(opt: FormTemplateOptions): string;
+    static buildListPage(opt: FormTemplateOptions): string;
+    static buildWorkspace(opt: FormTemplateOptions): string;
+    static build(pattern: FormPattern, opt: FormTemplateOptions): string;
+    /**
+     * Map common pattern name aliases to canonical FormPattern values.
+     * Handles various casing and abbreviation styles the AI or user might use.
+     */
+    static normalizePattern(raw: string): FormPattern;
+}
+//# sourceMappingURL=formPatternTemplates.d.ts.map

package/dist/utils/formPatternTemplates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"formPatternTemplates.d.ts","sourceRoot":"","sources":["../../src/utils/formPatternTemplates.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,KAAK,eAAe,EAAmB,MAAM,wBAAwB,CAAC;AAE/E,MAAM,WAAW,mBAAmB;IAClC,iDAAiD;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oEAAoE;IACpE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,uDAAuD;IACvD,QAAQ,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACpD,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yDAAyD;IACzD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iEAAiE;IACjE,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;OAIG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,yEAAyE;IACzE,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED,+CAA+C;AAC/C,MAAM,MAAM,WAAW,GACnB,YAAY,GACZ,mBAAmB,GACnB,eAAe,GACf,oBAAoB,GACpB,QAAQ,GACR,iBAAiB,GACjB,QAAQ,GACR,UAAU,GACV,WAAW,CAAC;AAEhB,qBAAa,oBAAoB;IAE/B;;;;;;;;OAQG;IACH,MAAM,CAAC,YAAY,CACjB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,UAAU,SAAK,EACf,KAAK,CAAC,EAAE,eAAe,GACtB,MAAM,CAYR;IAGD,MAAM,CAAC,eAAe,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,CA+IvD;IAGD,MAAM,CAAC,sBAAsB,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,CAqM9D;IAGD,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,CAyT1D;IAQD,MAAM,CAAC,uBAAuB,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,CA6f/D;IASD,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,CA8InD;IAQD,MAAM,CAAC,oBAAoB,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,CA0I5D;IAQD,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,CA6EnD;IAWD,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,CAiKrD;IAWD,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,CAsMtD;IAKD,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,mBAAmB,GAAG,MAAM,CAanE;IAED;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAYhD;CACF"}