☰

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.9
  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.     const generateComments = function(fieldName, fieldValue) {
  16.     return `
  17. /**
  18. * ${fieldName}: ${fieldValue}
  19. */`
  20.     }
  21.     // Create a button element and style it to be fixed in the bottom-right corner.
  22.     const btn = document.createElement('button');
  23.     btn.textContent = 'Generate TypeScript Signatures';
  24.     btn.style.position = 'fixed';
  25.     btn.style.bottom = '20px';
  26.     btn.style.right = '20px';
  27.     btn.style.padding = '10px';
  28.     btn.style.backgroundColor = '#007ACC';
  29.     btn.style.color = '#fff';
  30.     btn.style.border = 'none';
  31.     btn.style.borderRadius = '5px';
  32.     btn.style.cursor = 'pointer';
  33.     btn.style.zIndex = 10000;
  34.     document.body.appendChild(btn);
  35.  
  36.     btn.addEventListener('click', () => {
  37.         // Mapping objects for Xrm attribute and control types.
  38.         var attributeTypeMapping = {
  39.             "boolean": "Xrm.Attributes.BooleanAttribute",
  40.             "datetime": "Xrm.Attributes.DateAttribute",
  41.             "decimal": "Xrm.Attributes.NumberAttribute",
  42.             "double": "Xrm.Attributes.NumberAttribute",
  43.             "integer": "Xrm.Attributes.NumberAttribute",
  44.             "lookup": "Xrm.Attributes.LookupAttribute",
  45.             "memo": "Xrm.Attributes.StringAttribute",
  46.             "money": "Xrm.Attributes.NumberAttribute",
  47.             "multiselectoptionset": "Xrm.Attributes.MultiselectOptionSetAttribute",
  48.             "optionset": "Xrm.Attributes.OptionSetAttribute",
  49.             "string": "Xrm.Attributes.StringAttribute"
  50.         };
  51.  
  52.         var controlTypeMapping = {
  53.             "standard": "Xrm.Controls.StandardControl",
  54.             "iframe": "Xrm.Controls.IframeControl",
  55.             "lookup": "Xrm.Controls.LookupControl",
  56.             "optionset": "Xrm.Controls.OptionSetControl",
  57.             "customsubgrid:MscrmControls.Grid.GridControl": "Xrm.Controls.GridControl",
  58.             "subgrid": "Xrm.Controls.GridControl",
  59.             "timelinewall": "Xrm.Controls.TimelineWall",
  60.             "quickform": "Xrm.Controls.QuickFormControl"
  61.         };
  62.  
  63.         var specificControlTypeMapping = {
  64.             "boolean": "Xrm.Controls.BooleanControl",
  65.             "datetime": "Xrm.Controls.DateControl",
  66.             "decimal": "Xrm.Controls.NumberControl",
  67.             "double": "Xrm.Controls.NumberControl",
  68.             "integer": "Xrm.Controls.NumberControl",
  69.             "lookup": "Xrm.Controls.LookupControl",
  70.             "memo": "Xrm.Controls.StringControl",
  71.             "money": "Xrm.Controls.NumberControl",
  72.             "multiselectoptionset": "Xrm.Controls.MultiselectOptionSetControl",
  73.             "optionset": "Xrm.Controls.OptionSetControl",
  74.             "string": "Xrm.Controls.StringControl"
  75.         }
  76.  
  77.         // Object to hold the type information.
  78.         const typeInfoTemplate = { attributes: {}, controls: {}, possibleTypes: {}, enums: {} }
  79.         const entityTypeInfos = {};
  80.  
  81.         // Loop through all controls on the form.
  82.         if (typeof Xrm !== 'undefined' && Xrm.Page && typeof Xrm.Page.getControl === 'function') {
  83.             let entity = Xrm.Page.data.entity.getEntityName();
  84.             let typeInfo = entityTypeInfos[entity] = entityTypeInfos[entity] ?? typeInfoTemplate;
  85.             Xrm.Page.getControl().forEach((ctrl) => {
  86.                 const ctrlType = ctrl.getControlType();
  87.                 const mappedType = controlTypeMapping[ctrlType];
  88.                 if (mappedType) {
  89.                     typeInfo.controls[ctrl.getName()] = mappedType;
  90.                     typeInfo.possibleTypes[ctrl.getName()] = [];
  91.                     typeInfo.possibleTypes[ctrl.getName()].push(mappedType);
  92.                 }
  93.             });
  94.         } else {
  95.             alert("Xrm.Page is not available on this page.");
  96.             return;
  97.         }
  98.  
  99.         // Loop through all Quick View controls on the form.
  100.         if (typeof Xrm.Page.ui.quickForms.get === 'function') {
  101.             let entity = Xrm.Page.data.entity.getEntityName();
  102.             let typeInfo = entityTypeInfos[entity] = entityTypeInfos[entity] ?? typeInfoTemplate;
  103.             Xrm.Page.ui.quickForms.get().forEach((ctrl) => {
  104.                 const ctrlType = ctrl.getControlType();
  105.                 const mappedType = controlTypeMapping[ctrlType];
  106.                 if (mappedType) {
  107.                     typeInfo.possibleTypes[ctrl.getName()] = typeInfo.possibleTypes[ctrl.getName()] ?? [];
  108.                     typeInfo.possibleTypes[ctrl.getName()].push(mappedType);
  109.                 }
  110.             });
  111.         }
  112.  
  113.         // Loop through all tabs and sections on the form.
  114.         if (typeof Xrm.Page.ui.tabs.get === 'function') {
  115.             let entity = Xrm.Page.data.entity.getEntityName();
  116.             let typeInfo = entityTypeInfos[entity] = entityTypeInfos[entity] ?? typeInfoTemplate;
  117.             Xrm.Page.ui.tabs.get().forEach((tab) => {
  118.                 typeInfo.possibleTypes[tab.getName()] = typeInfo.possibleTypes[tab.getName()] ?? [];
  119.                 typeInfo.possibleTypes[tab.getName()].push("Xrm.Controls.Tab");
  120.                 tab.sections.forEach((section) => {
  121.                     typeInfo.possibleTypes[section.getName()] = typeInfo.possibleTypes[section.getName()] ?? [];
  122.                     typeInfo.possibleTypes[section.getName()].push("Xrm.Controls.Section");   
  123.                 });
  124.             });
  125.         }
  126.  
  127.         // Loop through all attributes on the form.
  128.         if (typeof Xrm.Page.getAttribute === 'function') {
  129.             let entity = Xrm.Page.data.entity.getEntityName();
  130.             let typeInfo = entityTypeInfos[entity] = entityTypeInfos[entity] ?? typeInfoTemplate;
  131.             Xrm.Page.getAttribute().forEach((attr) => {
  132.                 const attrType = attr.getAttributeType();
  133.                 const mappedType = attributeTypeMapping[attrType];
  134.                 const mappedControlType = specificControlTypeMapping[attrType];
  135.                 if (mappedType) {
  136.                     typeInfo.attributes[attr.getName()] = mappedType;
  137.                     typeInfo.controls[attr.getName()] = mappedControlType;
  138.                     typeInfo.possibleTypes[attr.getName()] = [];
  139.                     if (attrType !== "optionset") {
  140.                         typeInfo.possibleTypes[attr.getName()].push(mappedType);
  141.                     }
  142.                     typeInfo.possibleTypes[attr.getName()].push(mappedControlType);
  143.                 }
  144.             });
  145.         }
  146.  
  147.         // Loop through all enums on the form.
  148.         if (typeof Xrm.Page.getAttribute === 'function') {
  149.             let entity = Xrm.Page.data.entity.getEntityName();
  150.             let typeInfo = entityTypeInfos[entity] = entityTypeInfos[entity] ?? typeInfoTemplate;
  151.             Xrm.Page.getAttribute().forEach((attr) => {
  152.                 if (attr.getAttributeType() === "optionset" && attr.controls.get().length > 0) {
  153.                     const enumValues = attr.getOptions();
  154.                     const attrName = attr.getName();
  155.                     const controlName = attr.controls.get(0).getLabel().replace(/\s+/g, '');
  156.                     if (enumValues) {
  157.                         typeInfo.enums[controlName] = {attribute: "", values: []};
  158.                         typeInfo.enums[controlName].values = enumValues;
  159.                         typeInfo.enums[controlName].attribute = attrName;
  160.                         typeInfo.attributes[attrName] = attrName;
  161.                         typeInfo.possibleTypes[attrName].push(attrName);
  162.                     }
  163.                 }
  164.             });
  165.         }
  166.  
  167.         // Build the TypeScript overload string.
  168.         let outputTS = `// This file is generated automatically.
  169. // It extends the Xrm.FormContext interface with overloads for getAttribute and getControl.
  170. // Do not modify this file manually.
  171. `
  172. for(const [entityName, typeInfo] of Object.entries(entityTypeInfos)) {
  173.     for(const [enumName, enumValues] of Object.entries(typeInfo.enums)) {
  174.         let enumTemplate = [];
  175.         for(const enumValue of enumValues.values) {
  176.             enumTemplate.push(`   ${enumValue.text.replace(/\W/g, '')} = ${enumValue.value}`);
  177.         }
  178. outputTS += generateComments("Entity", entityName);
  179. outputTS += `
  180. const enum ${enumName} {
  181. ${enumTemplate.join(",\n")}
  182. }
  183. `
  184. outputTS += generateComments("Entity", entityName);
  185. outputTS += `
  186. interface ${enumValues.attribute} extends Xrm.Attributes.OptionSetAttribute {
  187.   getValue(): ${enumName} | null;
  188.   setValue(value: ${enumName} | null): void;
  189. }
  190. `
  191.     }
  192. }
  193. outputTS += `
  194. declare namespace Xrm {
  195.     namespace Collection {
  196.         interface ItemCollection<T> {
  197. `
  198. for(const [entityName, typeInfo] of Object.entries(entityTypeInfos)) {
  199.     for (const [possibleTypeName, possibleTypesArray] of Object.entries(typeInfo.possibleTypes)) {
  200.         let possibleTypeTemplate = "";
  201.         for (const possibleType of possibleTypesArray) {
  202.             possibleTypeTemplate += ` TSubType extends ${possibleType} ? ${possibleType} :`;
  203.         }
  204.         outputTS += generateComments("Entity", entityName);
  205.         outputTS += ` get<TSubType extends T>(itemName: "${possibleTypeName}"):${possibleTypeTemplate} never;\n`;
  206.     }
  207. }
  208. outputTS += `
  209.     }
  210. }`
  211. outputTS += `
  212.   interface FormContext {
  213. `;
  214. for(const [entityName, typeInfo] of Object.entries(entityTypeInfos)) {
  215.     for (const [attributeName, attributeType] of Object.entries(typeInfo.attributes)) {
  216.         outputTS += generateComments("Entity", entityName);
  217.         outputTS += ` getAttribute(attributeName: "${attributeName}"): ${attributeType};\n`;
  218.     }
  219.     for (const [controlName, controlType] of Object.entries(typeInfo.controls)) {
  220.         outputTS += generateComments("Entity", entityName);
  221.         outputTS += ` getControl(controlName: "${controlName}"): ${controlType};\n`;
  222.     }
  223. } 
  224.         outputTS += `  }
  225. }
  226. `;
  227.  
  228.         // Create a new window with a textarea showing the output.
  229.         // The textarea is set to readonly to prevent editing.
  230.         const w = window.open('', '_blank', 'width=600,height=400,menubar=no,toolbar=no,location=no,resizable=yes');
  231.         if (w) {
  232.             w.document.write('<html><head><title>TypeScript Overload Signatures</title></head><body>');
  233.             w.document.write('<textarea readonly style="width:100%; height:90%;">' + outputTS + '</textarea>');
  234.             w.document.write('</body></html>');
  235.             w.document.close();
  236.         } else {
  237.             // Fallback to prompt if popups are blocked.
  238.             prompt("Copy the TypeScript definition:", outputTS);
  239.         }
  240.     });
  241. })();