☰

Microsoft Power Platform/Dynamics 365 CE - Generate TypeScript Overload Signatures

Automatically creates TypeScript type definitions compatible with @types/xrm by extracting form attributes and controls from Dynamics 365/Power Platform model-driven applications.

当前为 2025-03-17 提交的版本，查看 最新版本。

  1. // ==UserScript==
  2. // @name         Microsoft Power Platform/Dynamics 365 CE - Generate TypeScript Overload Signatures
  3. // @namespace    https://github.com/gncnpk/xrm-generate-ts-overloads
  4. // @author       Gavin Canon-Phratsachack (https://github.com/gncnpk)
  5. // @version      1.6
  6. // @license      GPL-3.0
  7. // @description  Automatically creates TypeScript type definitions compatible with @types/xrm by extracting form attributes and controls from Dynamics 365/Power Platform model-driven applications.
  8. // @match        https://*.dynamics.com/main.aspx?appid=*&pagetype=entityrecord&etn=*&id=*
  9. // @grant        none
  10. // ==/UserScript==
  11.  
  12. (function() {
  13.     'use strict';
  14.  
  15.     // Create a button element and style it to be fixed in the bottom-right corner.
  16.     const btn = document.createElement('button');
  17.     btn.textContent = 'Generate TypeScript Signatures';
  18.     btn.style.position = 'fixed';
  19.     btn.style.bottom = '20px';
  20.     btn.style.right = '20px';
  21.     btn.style.padding = '10px';
  22.     btn.style.backgroundColor = '#007ACC';
  23.     btn.style.color = '#fff';
  24.     btn.style.border = 'none';
  25.     btn.style.borderRadius = '5px';
  26.     btn.style.cursor = 'pointer';
  27.     btn.style.zIndex = 10000;
  28.     document.body.appendChild(btn);
  29.  
  30.     btn.addEventListener('click', () => {
  31.         // Mapping objects for Xrm attribute and control types.
  32.         var attributeTypeMapping = {
  33.             "boolean": "Xrm.Attributes.BooleanAttribute",
  34.             "datetime": "Xrm.Attributes.DateAttribute",
  35.             "decimal": "Xrm.Attributes.NumberAttribute",
  36.             "double": "Xrm.Attributes.NumberAttribute",
  37.             "integer": "Xrm.Attributes.NumberAttribute",
  38.             "lookup": "Xrm.Attributes.LookupAttribute",
  39.             "memo": "Xrm.Attributes.StringAttribute",
  40.             "money": "Xrm.Attributes.NumberAttribute",
  41.             "multiselectoptionset": "Xrm.Attributes.MultiselectOptionSetAttribute",
  42.             "optionset": "Xrm.Attributes.OptionSetAttribute",
  43.             "string": "Xrm.Attributes.StringAttribute"
  44.         };
  45.  
  46.         var controlTypeMapping = {
  47.             "standard": "Xrm.Controls.StandardControl",
  48.             "iframe": "Xrm.Controls.IframeControl",
  49.             "lookup": "Xrm.Controls.LookupControl",
  50.             "optionset": "Xrm.Controls.OptionSetControl",
  51.             "customsubgrid:MscrmControls.Grid.GridControl": "Xrm.Controls.GridControl",
  52.             "subgrid": "Xrm.Controls.GridControl",
  53.             "timelinewall": "Xrm.Controls.TimelineWall",
  54.             "quickform": "Xrm.Controls.QuickFormControl"
  55.         };
  56.  
  57.         var specificControlTypeMapping = {
  58.             "boolean": "Xrm.Controls.BooleanControl",
  59.             "datetime": "Xrm.Controls.DateControl",
  60.             "decimal": "Xrm.Controls.NumberControl",
  61.             "double": "Xrm.Controls.NumberControl",
  62.             "integer": "Xrm.Controls.NumberControl",
  63.             "lookup": "Xrm.Controls.LookupControl",
  64.             "memo": "Xrm.Controls.StringControl",
  65.             "money": "Xrm.Controls.NumberControl",
  66.             "multiselectoptionset": "Xrm.Controls.MultiselectOptionSetControl",
  67.             "optionset": "Xrm.Controls.OptionSetControl",
  68.             "string": "Xrm.Controls.StringControl"
  69.         }
  70.  
  71.         // Object to hold the type information.
  72.         const typeInfo = { attributes: {}, controls: {}, possibleTypes: {} };
  73.  
  74.         const enums = {};
  75.  
  76.         // Loop through all controls on the form.
  77.         if (typeof Xrm !== 'undefined' && Xrm.Page && typeof Xrm.Page.getControl === 'function') {
  78.             Xrm.Page.getControl().forEach((ctrl) => {
  79.                 const ctrlType = ctrl.getControlType();
  80.                 const mappedType = controlTypeMapping[ctrlType];
  81.                 if (mappedType) {
  82.                     typeInfo.controls[ctrl.getName()] = mappedType;
  83.                     typeInfo.possibleTypes[ctrl.getName()] = [];
  84.                     typeInfo.possibleTypes[ctrl.getName()].push(mappedType);
  85.                 }
  86.             });
  87.         } else {
  88.             alert("Xrm.Page is not available on this page.");
  89.             return;
  90.         }
  91.  
  92.         // Loop through all enums on the form.
  93.         if (typeof Xrm.Page.getAttribute === 'function') {
  94.             Xrm.Page.getAttribute().forEach((attr) => {
  95.                 if (attr.getAttributeType() === "optionset" && attr.controls.get().length > 0) {
  96.                     const enumValues = attr.getOptions();
  97.                     if (enumValues) {
  98.                         enums[attr.controls.get(0).getLabel().replace(/\s+/g, '')] = enumValues;
  99.                     }
  100.                 }
  101.             });
  102.         }
  103.  
  104.         // Loop through all Quick View controls on the form.
  105.         if (typeof Xrm.Page.ui.quickForms.get === 'function') {
  106.             Xrm.Page.ui.quickForms.get().forEach((ctrl) => {
  107.                 const ctrlType = ctrl.getControlType();
  108.                 const mappedType = controlTypeMapping[ctrlType];
  109.                 if (mappedType) {
  110.                     typeInfo.possibleTypes[ctrl.getName()] = [];
  111.                     typeInfo.possibleTypes[ctrl.getName()].push(mappedType);
  112.                 }
  113.             });
  114.         }
  115.  
  116.         // Ensure that the Xrm.Page API is available.
  117.         if (typeof Xrm.Page.getAttribute === 'function') {
  118.             // Loop through all attributes on the form.
  119.             Xrm.Page.getAttribute().forEach((attr) => {
  120.                 const attrType = attr.getAttributeType();
  121.                 const mappedType = attributeTypeMapping[attrType];
  122.                 const mappedControlType = specificControlTypeMapping[attrType];
  123.                 if (mappedType) {
  124.                     typeInfo.attributes[attr.getName()] = mappedType;
  125.                     typeInfo.controls[attr.getName()] = mappedControlType;
  126.                     typeInfo.possibleTypes[attr.getName()] = [];
  127.                     typeInfo.possibleTypes[attr.getName()].push(mappedType);
  128.                     typeInfo.possibleTypes[attr.getName()].push(mappedControlType);
  129.                 }
  130.             });
  131.         }
  132.  
  133.         // Build the TypeScript overload string.
  134.         let outputTS = `// This file is generated automatically.
  135. // It extends the Xrm.FormContext interface with overloads for getAttribute and getControl.
  136. // Do not modify this file manually.
  137. `
  138. for(const [enumName, enumValues] of Object.entries(enums)) {
  139.     let enumTemplate = [];
  140.     for(const enumValue of enumValues) {
  141.         enumTemplate.push(`   ${enumValue.text.replace(/\W/g, '')} = ${enumValue.value}`);
  142.     }
  143. outputTS += `
  144. enum ${enumName} {
  145. ${enumTemplate.join(",\n")}
  146. }
  147. `
  148. }
  149. outputTS += `
  150. declare namespace Xrm {
  151.     namespace Collection {
  152.         interface ItemCollection<T> {
  153. `
  154. for (const [possibleTypeName, possibleTypesArray] of Object.entries(typeInfo.possibleTypes)) {
  155.     let possibleTypeTemplate = "";
  156.     for (const possibleType of possibleTypesArray) {
  157.         possibleTypeTemplate += ` TSubType extends ${possibleType} ? ${possibleType} : `;
  158.     }
  159.     outputTS += `    get<TSubType extends T>(itemName: "${possibleTypeName}"):${possibleTypeTemplate}never;\n`;
  160. }
  161. outputTS += `
  162.     }
  163. }`
  164. outputTS += `
  165.   interface FormContext {
  166. `;
  167.         for (const [attributeName, attributeType] of Object.entries(typeInfo.attributes)) {
  168.             outputTS += `    getAttribute(attributeName: "${attributeName}"): ${attributeType};\n`;
  169.         }
  170.  
  171.         for (const [controlName, controlType] of Object.entries(typeInfo.controls)) {
  172.             outputTS += `    getControl(controlName: "${controlName}"): ${controlType};\n`;
  173.         }
  174.  
  175.         outputTS += `  }
  176. }
  177. `;
  178.  
  179.         // Create a new window with a textarea showing the output.
  180.         // The textarea is set to readonly to prevent editing.
  181.         const w = window.open('', '_blank', 'width=600,height=400,menubar=no,toolbar=no,location=no,resizable=yes');
  182.         if (w) {
  183.             w.document.write('<html><head><title>TypeScript Overload Signatures</title></head><body>');
  184.             w.document.write('<textarea readonly style="width:100%; height:90%;">' + outputTS + '</textarea>');
  185.             w.document.write('</body></html>');
  186.             w.document.close();
  187.         } else {
  188.             // Fallback to prompt if popups are blocked.
  189.             prompt("Copy the TypeScript definition:", outputTS);
  190.         }
  191.     });
  192. })();