oliverflint / xrmtypesgen Goto Github PK

View Code? Open in Web Editor NEW

14.0 1.0 5.0 595 KB

A Typescript Type Declaration Generator for Dynamics 365

License: MIT License

JavaScript 1.45% TypeScript 95.92% Handlebars 2.63%

dynmaics 356 typescript javascript dataverse powerapps dynamics-365

xrmtypesgen's Introduction

XrmTypesGen

A Typescript Type Declaration Generator for Dynamics 365. Inspired by the @types/xrm and XrmDefinitelyTyped.

Usage

Generate your types

Install the npm package:

npm install xrmtypesgen -g

If you wish to install the package locally use the following:

npm install xrmtypesgen --save-dev

and run via npx:

npx xrmtypesgen [options]

Generate the Xrm types:

Username & Password Authentication

xrmtypesgen --url https://myorg.crm11.dynamics.com/ --username [email protected] --password password123 --tenent https://login.windows.net/org.onmicrosoft.com --solution solutionname --output ./types

Client Credential Authentication

xrmtypesgen --url https://myorg.crm11.dynamics.com/ --tenent https://login.windows.net/myorg.onmicrosoft.com --entities "account,contact,lead" --output types --clientid myclientid --secret mysecret

Arguments:

Usage: xrmtypesgen [options]

Options:
  -V, --version              output the version number
  -u, --url <url>            D365/Dataverse Url. e.g. https://myorg.crm11.dynamics.com/
  -n, --username <username>  Username for D365/Dataverse
  -p, --password <password>  Password for D365/Dataverse
  --secret <secret>          OAuth Client Secret
  -t, --tenent <tenent>      Azure Active Directory authority. e.g. https://login.windows.net/myorg.onmicrosoft.com
  -c, --clientid <clientid>  OAuth Client Id (default: "51f81489-12ee-4a9e-aaae-a2591f45987d")
  -s, --solution <solution>  Unique D365/Dataverse Solution Name
  -e, --entities <entities>  Comma seperated list of entities
  -o, --output <output>      Output path (default: "types")
  -h, --help                 display help for command

e.g. xrmtypesgen --url https://myorg.crm11.dynamics.com/ --username [email protected] --password password123 --tenent https://login.windows.net/myorg.onmicrosoft.com --solution solutionname --output ./types

e.g. xrmtypesgen --url https://myorg.crm11.dynamics.com/ --username [email protected] --password password123 --tenent https://login.windows.net/myorg.onmicrosoft.com --entities account,contact,lead --output ./types

e.g. xrmtypesgen --url https://myorg.crm11.dynamics.com/ --tenent https://login.windows.net/myorg.onmicrosoft.com --entities "account,contact,lead" --output types --clientid myclientid --secret mysecret

Using your types

The generated type declaration depend on @types/xrm, so lets install them

npm install @types/xrm --save-dev

You are now free to use the new type declaration... Here are some examples.

Form Context:

function myfunc(context: Xrm.Events.EventContext) {
  const formContext = context.getFormContext() as Xrm.Ext.Forms.contact.main.Contact.Form;
  ...
}

Get an attribute, and set the value:

formContext.getAttribute('birthdate').setValue(new Date(1990, 6, 20));

Disable the 'birth date' control within the section called 'PERSONAL INFORMATION', that is within the tab called 'DETAILS_TAB':

formContext.ui.tabs
  .get('DETAILS_TAB')
  .sections.get('PERSONAL INFORMATION')
  .controls.get('birthdate')
  .setDisabled(true);

Here's a little video demo...

Why?

Well, I've been using @types/xrm for over 5 years now and XrmDefinitelyTyped for about 2 years. I love the added features XrmDefinitelyTyped provides but dislike the fact that it doesn't extend on @types/xrm given most D365/XRM projects use these types. So I set about creating my own tool to generate type declarations that extend @type/xrm 😁

xrmtypesgen's People

Contributors

Stargazers

Watchers

Forkers

kato88 betimbeja janis-veinbergs deepak3405

xrmtypesgen's Issues

Migrate from adal-node to msal-node

Migration guide here... https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/migration.md

[Feature Request] Filter Generated Forms

It would be nice to have an option to read the configuration from file, so that we could add more advanced filters. Like white lists, or black lists for forms or entities. Or specify a list of forms. for example a file XrmTypesGen.config.json like this:

{
  "entities": {
      "account": "Account",
      "contact": ["Contact", "Information"],
      "lead": true
  }
}

Failed to generate with auto generated tab names

When running xrmtypesgen and a form has a tab with an auto generated Guid name it fails with the following error message:

(node:35236) UnhandledPromiseRejectionWarning: SyntaxError: An identifier or keyword cannot immediately follow a numeric literal. (382:79)
  380 |                 * @returns `Xrm.Controls.Tab`.
  381 |                 */
> 382 |                 get(tabname: "{695e07fd-fedf-4e04-ba92-366f59c2c2a2}"): 695e07fdfedf4e04ba92366f59c2c2a2TabControl
      |                                                                               ^
  383 |             }
  384 | 
  385 |             type 695e07fdfedf4e04ba92366f59c2c2a2TabControl = Xrm.Controls.Tab & {
    at e (C:\dev\Test\node_modules\prettier\parser-typescript.js:1:322)
    at Object.parse (C:\dev\Test\node_modules\prettier\parser-typescript.js:1:3072720)
    at Object.parse (C:\dev\Test\node_modules\prettier\index.js:13625:19)
    at coreFormat (C:\dev\Test\node_modules\prettier\index.js:14899:14)
    at format (C:\dev\Test\node_modules\prettier\index.js:15131:14)
    at C:\dev\Test\node_modules\prettier\index.js:57542:12
    at Object.format (C:\dev\Test\node_modules\prettier\index.js:57562:12)
    at Object.render (C:\dev\Test\node_modules\xrmtypesgen\dist\renderer.js:26:34)
    at C:\dev\Test\node_modules\xrmtypesgen\dist\index.js:60:33
    at processTicksAndRejections (internal/process/task_queues.js:93:5)

[Feature Request] Generate Entities compatible with @albanian-xrm/early-bound

I know it is much to ask ;) but:
I would like to add an option to generate the EarlyBound models in a slightly different format which is compatible with the new package that I have created: @albanian-xrm/early-bound
I will issue a PR myself soon for this.

option name & npm warning

The /tenent switch should be /tenant
Getting a warning during install

*I found this article and wanted to get your thoughts on the claim

The first thing to be aware of is that @types/xrm and XrmDefinitelyTyped are incompatible with each other. You cannot have the DefinitelyTyped type definitions in the same compilation context as the XrmDefinitelyTyped definitions.

https://dyncrmexp.com/2020/06/28/modern-web-resource-workspace-in-dynamics-365-part-2-declaration-files/comment-page-1/

Add support for @types/xrm@v8

There are still a lot of old on premise implementations working with @types/xrm v8, I happen work on a project like this daily 😀
It would be nice to support those projects too.