Automatically creates TypeScript type definitions compatible with @types/xrm by extracting form attributes and controls from Dynamics 365/Power Platform model-driven applications.
当前为
// ==UserScript==
// @name Microsoft Power Platform/Dynamics 365 CE - Generate TypeScript Definitions
// @namespace https://github.com/gncnpk/xrm-generate-ts-overloads
// @author Gavin Canon-Phratsachack (https://github.com/gncnpk)
// @version 1.953
// @license GPL-3.0
// @description Automatically creates TypeScript type definitions compatible with @types/xrm by extracting form attributes and controls from Dynamics 365/Power Platform model-driven applications.
// @match https://*.dynamics.com/main.aspx?appid=*&pagetype=entityrecord&etn=*&id=*
// @grant none
// ==/UserScript==
(function () {
"use strict";
const generateComments = function (fieldName, fieldValue) {
return `\n/** ${fieldName}: ${fieldValue} */`;
};
// Create a button element and style it to be fixed in the bottom-right corner.
const btn = document.createElement("button");
btn.textContent = "Generate TypeScript Definitions";
btn.style.position = "fixed";
btn.style.bottom = "20px";
btn.style.right = "20px";
btn.style.padding = "10px";
btn.style.backgroundColor = "#007ACC";
btn.style.color = "#fff";
btn.style.border = "none";
btn.style.borderRadius = "5px";
btn.style.cursor = "pointer";
btn.style.zIndex = 10000;
document.body.appendChild(btn);
btn.addEventListener("click", () => {
// Mapping objects for Xrm attribute and control types.
var attributeTypeMapping = {
boolean: "Xrm.Attributes.BooleanAttribute",
datetime: "Xrm.Attributes.DateAttribute",
decimal: "Xrm.Attributes.NumberAttribute",
double: "Xrm.Attributes.NumberAttribute",
integer: "Xrm.Attributes.NumberAttribute",
lookup: "Xrm.Attributes.LookupAttribute",
memo: "Xrm.Attributes.StringAttribute",
money: "Xrm.Attributes.NumberAttribute",
multiselectoptionset: "Xrm.Attributes.MultiselectOptionSetAttribute",
optionset: "Xrm.Attributes.OptionSetAttribute",
string: "Xrm.Attributes.StringAttribute",
};
var controlTypeMapping = {
standard: "Xrm.Controls.StandardControl",
iframe: "Xrm.Controls.IframeControl",
lookup: "Xrm.Controls.LookupControl",
optionset: "Xrm.Controls.OptionSetControl",
"customsubgrid:MscrmControls.Grid.GridControl":
"Xrm.Controls.GridControl",
subgrid: "Xrm.Controls.GridControl",
timelinewall: "Xrm.Controls.TimelineWall",
quickform: "Xrm.Controls.QuickFormControl",
};
var specificControlTypeMapping = {
boolean: "Xrm.Controls.BooleanControl",
datetime: "Xrm.Controls.DateControl",
decimal: "Xrm.Controls.NumberControl",
double: "Xrm.Controls.NumberControl",
integer: "Xrm.Controls.NumberControl",
lookup: "Xrm.Controls.LookupControl",
memo: "Xrm.Controls.StringControl",
money: "Xrm.Controls.NumberControl",
multiselectoptionset: "Xrm.Controls.MultiselectOptionSetControl",
optionset: "Xrm.Controls.OptionSetControl",
string: "Xrm.Controls.StringControl",
};
// Object to hold the type information.
const typeInfo = {
subGrids: {},
quickViews: {},
formAttributes: {},
formControls: {},
formPossibleTypes: {},
formEnums: {},
quickViewControls: {},
quickViewAttributes: {},
};
class Subgrid {
constructor() {
this.attributes = {};
this.enums = {};
}
}
class QuickForm {
constructor() {
this.attributes = {};
this.controls = {};
this.enums = {};
}
}
// Loop through all controls on the form.
if (
typeof Xrm !== "undefined" &&
Xrm.Page &&
typeof Xrm.Page.getControl === "function"
) {
Xrm.Page.getControl().forEach((ctrl) => {
const ctrlType = ctrl.getControlType();
const mappedType = controlTypeMapping[ctrlType];
if (mappedType) {
typeInfo.formControls[ctrl.getName()] = mappedType;
typeInfo.formPossibleTypes[ctrl.getName()] = [];
typeInfo.formPossibleTypes[ctrl.getName()].push(mappedType);
}
});
} else {
alert("Xrm.Page is not available on this page.");
return;
}
// Loop through all tabs and sections on the form.
if (typeof Xrm.Page.ui.tabs.get === "function") {
Xrm.Page.ui.tabs.get().forEach((tab) => {
typeInfo.formPossibleTypes[tab.getName()] =
typeInfo.formPossibleTypes[tab.getName()] ?? [];
typeInfo.formPossibleTypes[tab.getName()].push("Xrm.Controls.Tab");
tab.sections.forEach((section) => {
typeInfo.formPossibleTypes[section.getName()] =
typeInfo.formPossibleTypes[section.getName()] ?? [];
typeInfo.formPossibleTypes[section.getName()].push(
"Xrm.Controls.Section"
);
});
});
}
// Loop through all attributes on the form.
if (typeof Xrm.Page.getAttribute === "function") {
Xrm.Page.getAttribute().forEach((attr) => {
const attrType = attr.getAttributeType();
const attrName = attr.getName();
const mappedType = attributeTypeMapping[attrType];
const mappedControlType = specificControlTypeMapping[attrType];
if (mappedType) {
typeInfo.formAttributes[attrName] = mappedType;
typeInfo.formControls[attrName] = mappedControlType;
typeInfo.formPossibleTypes[attrName] = [];
if (attrType !== "optionset") {
typeInfo.formPossibleTypes[attrName].push(mappedType);
typeInfo.formPossibleTypes[attrName].push(mappedControlType);
}
}
if (
attr.getAttributeType() === "optionset" &&
attr.controls.get().length > 0
) {
const enumValues = attr.getOptions();
if (enumValues) {
typeInfo.formEnums[attrName] = { attribute: "", values: [] };
typeInfo.formEnums[attrName].values = enumValues;
typeInfo.formEnums[attrName].attribute = attrName;
typeInfo.formAttributes[attrName] = `${attrName}_attribute`;
typeInfo.formPossibleTypes[attrName].push(`${attrName}_attribute`);
typeInfo.formPossibleTypes[attrName].push(mappedControlType);
}
}
});
}
// Loop through all subgrids on the form.
if (typeof Xrm.Page.getControl === "function") {
Xrm.Page.getControl().forEach((ctrl) => {
if (
ctrl.getControlType() === "subgrid" ||
ctrl.getControlType() ===
"customsubgrid:MscrmControls.Grid.GridControl"
) {
const gridRow = ctrl.getGrid().getRows().get(0);
const gridName = ctrl.getName();
let subgrid = (typeInfo.subGrids[gridName] = new Subgrid());
typeInfo.formControls[gridName] = `${gridName}_gridcontrol`;
if (gridRow !== null) {
gridRow.data.entity.attributes.forEach((attr) => {
const attrType = attr.getAttributeType();
const attrName = attr.getName();
const mappedType = attributeTypeMapping[attrType];
if (mappedType) {
subgrid.attributes[attrName] = mappedType;
}
if (
attr.getAttributeType() === "optionset" &&
attr.controls.get().length > 0
) {
const enumValues = attr.getOptions();
if (enumValues) {
subgrid.enums[attrName] = { attribute: "", values: [] };
subgrid.enums[attrName].values = enumValues;
subgrid.enums[attrName].attribute = attrName;
subgrid.attributes[attrName] = `${attrName}_attribute`;
}
}
});
}
}
});
}
// Loop through all Quick View controls and attributes on the form.
if (typeof Xrm.Page.ui.quickForms.get === "function") {
Xrm.Page.ui.quickForms.get().forEach((ctrl) => {
const quickViewName = ctrl.getName();
let quickView = (typeInfo.quickViews[quickViewName] = new QuickForm());
const ctrlType = ctrl.getControlType();
const mappedType = controlTypeMapping[ctrlType];
if (mappedType) {
typeInfo.formPossibleTypes[ctrl.getName()] =
typeInfo.formPossibleTypes[ctrl.getName()] ?? [];
typeInfo.formPossibleTypes[ctrl.getName()].push(
`${quickViewName}_quickformcontrol`
);
}
typeInfo.formControls[quickViewName] = `${quickViewName}_quickformcontrol`;
ctrl.getControl().forEach((subCtrl) => {
if (typeof subCtrl.getAttribute !== "function") {
return;
}
const subCtrlAttrType = subCtrl.getAttribute().getAttributeType();
const mappedControlType =
specificControlTypeMapping[subCtrlAttrType] ??
controlTypeMapping[subCtrl.getControlType()];
if (mappedControlType) {
quickView.controls[subCtrl.getName()] = mappedControlType;
}
});
ctrl.getAttribute().forEach((attr) => {
const attrType = attr.getAttributeType();
const attrName = attr.getName();
const mappedType = attributeTypeMapping[attrType];
if (mappedType) {
quickView.attributes[attrName] = mappedType;
}
if (attrType === "optionset" && attr.controls.get().length > 0) {
const enumValues = attr.getOptions();
if (enumValues) {
quickView.enums[attrName] = { attribute: "", values: [] };
quickView.enums[attrName].values = enumValues;
quickView.enums[attrName].attribute = attrName;
quickView.attributes[attrName] = `${attrName}_attribute`;
}
}
});
});
}
// Build the TypeScript overload string.
let outputTS = `// This file is generated automatically.
// It extends the Xrm.FormContext interface with overloads for getAttribute and getControl.
// Do not modify this file manually.
`;
let extendedAttributeTypes = [];
for (const [originalEnumName, enumValues] of Object.entries(
typeInfo.formEnums
)) {
let enumName = `${originalEnumName}_enum`;
let enumTemplate = [];
let textLiteralTypes = [];
let valueLiteralTypes = [];
for (const enumValue of enumValues.values) {
enumTemplate.push(
` ${enumValue.text.replace(/\W/g, "").replace(/[0-9]/g, "")} = ${
enumValue.value
}`
);
textLiteralTypes.push(`"${enumValue.text}"`);
valueLiteralTypes.push(
`${enumName}.${enumValue.text
.replace(/\W/g, "")
.replace(/[0-9]/g, "")}`
);
}
outputTS += `
const enum ${enumName} {
${enumTemplate.join(",\n")}
}
`;
outputTS += `
interface ${enumValues.attribute}_value extends Xrm.OptionSetValue {
text: ${textLiteralTypes.join(" | ")};
value: ${valueLiteralTypes.join(" | ")};
}
`;
outputTS += `
interface ${enumValues.attribute}_attribute extends Xrm.Attributes.OptionSetAttribute {
getOptions(): ${enumValues.attribute}_value[];
getSelectedOption(): ${enumValues.attribute}_value | null;
getValue(): ${enumName} | null;
setValue(value: ${enumName} | null): void;
}
`;
extendedAttributeTypes.push(`${enumValues.attribute}_attribute`);
}
for (const [subgridName, subgrid] of Object.entries(typeInfo.subGrids)) {
for (const [enumName, enumValues] of Object.entries(subgrid.enums)) {
let enumTemplate = [];
let textLiteralTypes = [];
let valueLiteralTypes = [];
for (const enumValue of enumValues.values) {
enumTemplate.push(
` ${enumValue.text.replace(/\W/g, "").replace(/[0-9]/g, "")} = ${
enumValue.value
}`
);
textLiteralTypes.push(`"${enumValue.text}"`);
valueLiteralTypes.push(
`${enumName}.${enumValue.text
.replace(/\W/g, "")
.replace(/[0-9]/g, "")}`
);
}
outputTS += `
const enum ${enumName}_enum {
${enumTemplate.join(",\n")}
}
`;
outputTS += `
interface ${enumValues.attribute}_value extends Xrm.OptionSetValue {
text: ${textLiteralTypes.join(" | ")};
value: ${valueLiteralTypes.join(" | ")};
}
`;
outputTS += `
interface ${enumValues.attribute}_attribute extends Xrm.Attributes.OptionSetAttribute {
getOptions(): ${enumValues.attribute}_value[];
getSelectedOption(): ${enumValues.attribute}_value | null;
getValue(): ${enumName}_enum | null;
setValue(value: ${enumName}_enum | null): void;
}
`;
}
outputTS += `
interface ${subgridName}_attributes extends Xrm.Collection.ItemCollection {`;
for (const [itemName, itemType] of Object.entries(subgrid.attributes)) {
outputTS += `get(itemName:"${itemName}"): ${itemType};\n`;
}
outputTS += `}
`;
outputTS += `
interface ${subgridName}_entity extends Xrm.Entity {
attributes: ${subgridName}_attributes;
}
interface ${subgridName}_data extends Xrm.Data {
entity: ${subgridName}_entity;
}
interface ${subgridName}_gridrow extends Xrm.Controls.Grid.GridRow {
data: ${subgridName}_data;
}
interface ${subgridName}_grid extends Xrm.Controls.Grid {
getRows(): Xrm.Collection.ItemCollection<${subgridName}_gridrow>;
}
interface ${subgridName}_gridcontrol extends Xrm.Controls.GridControl {
getGrid(): ${subgridName}_grid;
}
interface ${subgridName}_context extends Xrm.FormContext {`
for (const [itemName, itemType] of Object.entries(subgrid.attributes)) {
outputTS += `getAttribute(attributeName:"${itemName}"): ${itemType};\n`;
}
outputTS += `getAttribute(delegateFunction?: Collection.MatchingDelegate<Attributes.SpecificAttributeTypes>): ${subgridName}_attributes;`;
outputTS += `
}
`;
}
for (const [quickViewName, quickView] of Object.entries(
typeInfo.quickViews
)) {
for (const [enumName, enumValues] of Object.entries(quickView.enums)) {
let enumTemplate = [];
let textLiteralTypes = [];
let valueLiteralTypes = [];
for (const enumValue of enumValues.values) {
enumTemplate.push(
` ${enumValue.text.replace(/\W/g, "").replace(/[0-9]/g, "")} = ${
enumValue.value
}`
);
textLiteralTypes.push(`"${enumValue.text}"`);
valueLiteralTypes.push(
`${enumName}.${enumValue.text
.replace(/\W/g, "")
.replace(/[0-9]/g, "")}`
);
}
outputTS += `
const enum ${enumName}_enum {
${enumTemplate.join(",\n")}
}
`;
outputTS += `
interface ${enumValues.attribute}_value extends Xrm.OptionSetValue {
text: ${textLiteralTypes.join(" | ")};
value: ${valueLiteralTypes.join(" | ")};
}
`;
outputTS += `
interface ${enumValues.attribute}_attribute extends Xrm.Attributes.OptionSetAttribute {
getOptions(): ${enumValues.attribute}_value[];
getSelectedOption(): ${enumValues.attribute}_value | null;
getValue(): ${enumName}_enum | null;
setValue(value: ${enumName}_enum | null): void;
}
`;
}
outputTS += `interface ${quickViewName}_controls extends Xrm.Collection.ItemCollection {`
for(const [itemName, itemType] of Object.entries(quickView.controls)) {
outputTS += `get(itemName:"${itemName}"): ${itemType};\n`;
}
outputTS += `}`
outputTS += `
interface ${quickViewName}_attributes extends Xrm.Collection.ItemCollection {`;
for (const [itemName, itemType] of Object.entries(quickView.attributes)) {
outputTS += `get(itemName:"${itemName}"): ${itemType};\n`;
}
outputTS += `}`;
outputTS+= `
interface ${quickViewName}_quickformcontrol extends Xrm.Controls.QuickFormControl {
`
for (const [itemName, itemType] of Object.entries(quickView.controls)) {
outputTS += `getControl(controlName:"${itemName}"): ${itemType};\n`;
}
outputTS += `
getControl(): ${quickViewName}_controls
`
for (const [itemName, itemType] of Object.entries(quickView.attributes)) {
outputTS += `getAttribute(attributeName:"${itemName}"): ${itemType};\n`;
}
outputTS+=`
getAttribute(): ${quickViewName}_attributes;
}`;
}
outputTS += `
declare namespace Xrm {
interface Ui {
quickForms: Collection.ItemCollection<${
Object.keys(typeInfo.quickViews)
.map((quickViewName) => `${quickViewName}_quickformcontrol`)
.join(" | ")
}>
}
`;
outputTS += ` namespace Collection {
interface ItemCollection<T> {
`;
for (const [possibleTypeName, possibleTypesArray] of Object.entries(
typeInfo.formPossibleTypes
)) {
let possibleTypeTemplate = "";
for (const possibleType of possibleTypesArray) {
possibleTypeTemplate += ` TSubType extends ${possibleType} ? ${possibleType} :`;
}
outputTS += `\nget<TSubType extends T>(itemName: "${possibleTypeName}"):${possibleTypeTemplate} never;\n`;
}
outputTS += `
}
}`;
outputTS += `
interface FormContext {
`;
for (const [attributeName, attributeType] of Object.entries(
typeInfo.formAttributes
)) {
outputTS += `\ngetAttribute(attributeName: "${attributeName}"): ${attributeType};\n`;
}
for (const [controlName, controlType] of Object.entries(
typeInfo.formControls
)) {
outputTS += `\ngetControl(controlName: "${controlName}"): ${controlType};\n`;
}
outputTS += ` }
}
`;
// Create a new window with a textarea showing the output.
// The textarea is set to readonly to prevent editing.
const w = window.open(
"",
"_blank",
"width=600,height=400,menubar=no,toolbar=no,location=no,resizable=yes"
);
if (w) {
w.document.write(
"<html><head><title>TypeScript Definitions</title></head><body>"
);
w.document.write(
'<textarea readonly style="width:100%; height:90%;">' +
outputTS +
"</textarea>"
);
w.document.write("</body></html>");
w.document.close();
} else {
// Fallback to prompt if popups are blocked.
prompt("Copy the TypeScript definition:", outputTS);
}
});
})();