XrmDefinitelyTyped 7.0.0-preview.10

XrmDefinitelyTyped

XrmDefinitelyTyped generates TypeScript declaration files based on your Dynamics 365/CRM/xRM solution.

It is the TypeScript equivalent of CrmSvcUtil, but instead of generating early-bound .NET classes for server-side code, it generates TypeScript interfaces for all your client-side coding.

Read more here

Repository layout

This repository ships two artifacts: the generator and the runtime library that consumes what it generates.

XrmQuery used to be emitted onto disk by the tool itself via -jsLib. It is now a normal npm package with ES module exports — see src/XrmQuery/MIGRATION.md for moving off the old web-resource setup.

Releasing

Both artifacts are released by pushing a tag; the version is taken from the tag name.

git tag tool-v3.0.0     && git push origin tool-v3.0.0        # -> NuGet
git tag xrmquery-v0.1.0 && git push origin xrmquery-v0.1.0    # -> npm

Installation

The generated declarations build on the community-maintained standard Xrm declarations and the modern XrmQuery package instead of shipping a private copy of the full client API surface:

npm install --save-dev @types/xrm
npm install @delegateas/xrmquery

When form generation is enabled, XDT emits _internal/XrmDefinitelyTyped.d.ts. This is a small, generator-owned augmentation layer over @types/xrm that carries the additional precision XDT can provide: lookup target unions, typed form collections, concrete quick-view forms, and typed option set controls. It does not redeclare the complete Xrm namespace.

Configuration

Usage

The tool runs two generators. Pick them with --generate (-g); the default is both.

xdt -o typings                      # forms and web entity types
xdt -o typings --generate forms     # form types only
xdt -o typings --generate web       # web entity types for @delegateas/xrmquery only

Web entity types land in typings/Web/<entity>.d.ts (or a single typings/Web/WebEntities.d.ts with --single-file) inside the XDT namespace, overridable with --web-namespace. Option-set numeric union declarations are written to typings/_internal/Enum/ by whichever generator needs them.

Named option-set values are emitted as modern as const runtime objects in typings/OptionSets.ts:

import { ctx_subscription_statuscode } from "./typings/OptionSets";

const status: ctx_subscription_statuscode = ctx_subscription_statuscode.Active;

Importing the object provides discoverable named values while its same-named type remains the exact union of the Dataverse numeric values. Unlike an ambient const enum, this works with isolatedModules and module-based transpilers. Because it is a runtime value, the generated module must be imported by application code that uses its members.

Shared entity interfaces

Use --intersect (-i) to name the common contract of existing entities:

xdt -o typings --intersect "ICustomer:account;contact, IActivity:phonecall;email;task"

ICustomer represents what accounts and contacts have in common. With both generators enabled, this produces shared form types such as Form.ICustomer.Main.Information from the common controls, attributes, tabs and sections of forms with matching names and form types on every member entity, plus XDT.ICustomer_Select, XDT.ICustomer_Filter, XDT.ICustomer_Result and the other shared Web API interfaces. The ordinary entity and form declarations are still generated.

Shared attribute metadata must have matching TypeScript and attribute types; incompatible fields are omitted. Read/create/update permissions are retained only when supported by every entity. A shared query contract has no entity set: query the actual accounts or contacts endpoint, not an invented ICustomer endpoint. Different primary ID fields are not part of the common contract.

Include the named entities in the metadata selection (--entities / --solutions) if you filter it. Missing entity metadata causes an error rather than silently using only some member entities. Unmatched forms and matched forms with no compatible common controls or tabs are omitted. An entity without forms does not prevent generation of its shared XrmQuery interfaces. Intersection mappings accept entity logical names, not form GUIDs.

Configuration Options

Features