XrmDefinitelyTyped 7.0.0-preview.2

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

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 types are written to typings/_internal/Enum/ by whichever generator needs them.

Configuration Options

Features